Data

Tools

Indexes

Applications

Experiments

Open Source Science

research-project-template

Template for research projects

https://github.com/ellisbrown/research-project-template

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: arxiv.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

Template for research projects

Basic Info
  • Host: GitHub
  • Owner: ellisbrown
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 13.7 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 4 years ago · Last pushed almost 4 years ago
Metadata Files
Readme License Citation

README.md

### <<< DELETE ME: Template

This template contains some useful structure and convention for new research projects that will help you get started more quickly, and will make your code more accessible, maintainable, and reproducible. This will make your work more likely to be adopted by others!

I highly recommend taking a second to read Patrick Mineault's Good Research Code Handbook if you are in the process of starting a new project for many tips that will help you beyond the initial setup phase.

Note: You should delete everything within markdown blockquotes > before going live with your project.

### DELETE ME >>>

# Project Template `> REPLACE ME` A new project template for research projects. `> REPLACE ME` >
> > `### <<< DELETE ME` ***Badges*** *(optional)* > > If you have an arXiv paper, you can add and update the `[arXiv]` badge by > replacing `1234.56789` with the arXiv ID of your paper and the arXiv > subject `cs.LG` with the main subject. Else, delete it (or comment out). > > if your paper is published at a conference, you can add and update the > `[Conference]` badge by replacing `Conference`, `Year`, and the link fields. > Else, delete it (or comment out). > > It is also useful to add a CI build/test [status badge](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge) > to your project. A base Continuous Integration pipeline has been defined in > [.github/workflows/conda-test.yml](.github/workflows/conda-test.yml) > GitHub will automatically register and run this pipeline when you push to the > `main` branch. > > Copy the workflow badge from the corresponding workflow in the Actions tab > (click the breadcrumbs) and overwrite the Conda Test badge below. > > > `### DELETE ME >>>` > >
[![Conda Test](https://github.com/ellisbrown/research-project/actions/workflows/conda-test.yml/badge.svg)](https://github.com/ellisbrown/research-project/actions/workflows/conda-test.yml) [![arXiv](https://img.shields.io/badge/cs.LG-arXiv:1234.56789-b31b1b.svg)](https://arxiv.org/abs/1234.56789) [![Conference](https://img.shields.io/badge/Conference-year-4b44ce.svg)](https://yourconference.org/2020)

Description

### <<< DELETE ME: Description

Fill in a succinct description of your project.

### DELETE ME >>>

Setup

### <<< DELETE ME: Setup

Below are some base instructions for setting up a conda environment. See this guide to Conda to learn some great best practices!

Add any instructions necessary to setup the project. The best time to create this is as you are developing the project, while you remember the steps you have taken.

Brownie points: try to follow your setup instructions to replicate the setup from scratch on another machine to ensure that it is truly reproducible.

### DELETE ME >>>

Conda Virtual Environment

Create the Conda virtual environment using the environment file: ```bash conda env create -f environment.yml

dynamically set python path for the environment

conda activate YOUR_PROJECT conda env config vars set PYTHONPATH=$(pwd):$(pwd)/src ```

Usage

### <<< DELETE ME: Usage

Provide information on how to run your project. Delete the below example.

### DELETE ME >>>

```python from foo import bar

bar.baz("hello world") ```

bash python -m foo.bar "hello world"

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Citation

### <<< DELETE ME: Citation

Adding a citation to your README will make it easier for others to cite your work. Add your bibtext citation to the README below. GitHub also will automatically detect Citation File Format (.cff) files, rendering a "Cite this repository" button. See GitHub's tutorial for more information. The example from this tutorial is included in CITATION.cff, and should be modified or deleted.

### DELETE ME >>>

bibtex @article{YourName, title={Your Title}, author={Your team}, year={Year} }

Owner

  • Name: Ellis Brown
  • Login: ellisbrown
  • Kind: user
  • Location: Pittsburgh
  • Company: CMU

MSCS @ CMU | Formerly Founding Engineer @ BlackRock AI Labs

Citation (CITATION.cff) 


# See GiHub's Doc on citation files: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

# Below is the citation for this template repository. Replace it with your own!

### REPLACE ME >>>

cff-version: 1.2.0
title: >-
  Research Project Template
message: >-
  If you find this project or code useful, please consider citing it as below!
type: software
authors:
  - given-names: Ellis L
    family-names: Brown
    name-suffix: II
    email: ellisbrown@cmu.edu
    affiliation: Carnegie Mellon University 
    orcid: 'https://orcid.org/0000-0002-8117-0778 '

### REPLACE ME <<<

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels