Data

Tools

Indexes

Applications

Experiments

Open Source Science

researchproject-template

Template github repo for starting a new data/network science research project

https://github.com/nerdsitu/researchproject-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, zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary

Keywords

cookiecutter data-science network-science python research-project template
Last synced: 6 months ago · JSON representation ·

Repository

Template github repo for starting a new data/network science research project

Basic Info
  • Host: GitHub
  • Owner: NERDSITU
  • Default Branch: main
  • Homepage:
  • Size: 41 KB
Statistics
  • Stars: 6
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Topics
cookiecutter data-science network-science python research-project template
Created about 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Citation

README.md

The purpose of this template is to be a foundation for creating a new research project, specifically for data/network science research in the NERDS research group - but feel free to use it in any way. The template comes with a basic folder structure and a workflow adapted for programming using Python.

⚠️ Read TEMPLATE.md to know how to use the template ⚠️

PROJECTNAME

Ruff code style: prettier pre-commit

This is the source code for the scientific paper/project PROJECTNAME by AUTHOR1, AUTHOR2, and AUTHOR3. The code SHORTEXPLANATION.

Preprint: arXiv:XXXX.XXXXX
Data repository: zenodo.XXXXXXX

PROJECTNAME

Installation

First clone the repository:

git clone https://github.com/USER/REPO.git

Go to the cloned folder and create a new virtual environment. You can either create a new virtual environment then install the necessary dependencies with pip using the requirements.txt file:

pip install -r requirements.txt

Or create a new environment with the dependencies with conda or mamba using the environment.yml file:

mamba env create -f environment.yml Then, install the virtual environment's kernel in Jupyter:

mamba activate ENVNAME ipython kernel install --user --name=ENVNAME mamba deactivate

You can now run jupyter lab with kernel ENVNAME (Kernel > Change Kernel > ENVNAME).

Repository structure

├── data │ ├── processed <- Modified data │ └── raw <- Original, immutable data ├── notebooks <- Jupyter notebooks ├── plots <- Generated figures ├── scripts <- Scripts to execute ├── .gitignore <- Files and folders ignored by git ├── .pre-commit-config.yaml <- Pre-commit hooks used ├── CITATION.cff <- Citation file (template) ├── README.md ├── TEMPLATE.md <- Explanation for the template, delete it after use ├── environment.yml <- Environment file to set up the environment using conda/mamba └── requirements.txt <- Requirements file to set up the environment using pip

Credits

Please cite as:

AUTHOR1, AUTHOR2, and AUTHOR3, PROJECTNAME, JOURNAL (YYYY), DOIURL

Development of PROJECTNAME was supported by FUNDER.

Owner

  • Name: NERDS
  • Login: NERDSITU
  • Kind: organization
  • Location: Denmark

NEtworks, Data, and Society research group at ITU Copenhagen

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this source code, please cite it as below."
authors:
- family-names: "AUTHOR1"
  given-names: "AUTHOR1GIVEN"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "AUTHOR2"
  given-names: "AUTHOR2GIVEN"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "AUTHOR3"
  given-names: "AUTHOR3GIVEN"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "PROJECTNAME"
version: 1.0.0
doi: 10.5281/zenodo.0000
date-released: YYYY-MM-DD
url: "URL"
preferred-citation:
  type: article
  authors:
  - family-names: "AUTHOR1"
  given-names: "AUTHOR1GIVEN"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "AUTHOR2"
  given-names: "AUTHOR2GIVEN"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "AUTHOR3"
  given-names: "AUTHOR3GIVEN"
  orcid: "https://orcid.org/0000-0000-0000-0000"
  doi: "10.0000/00000"
  journal: "JOURNAL"
  month: 1
  start: 1
  end: 2
  title: "PROJECTNAME"
  issue: 1
  volume: 1
  year: YYYY

GitHub Events

Total
  • Watch event: 2
  • Push event: 1
  • Fork event: 1
Last Year
  • Watch event: 2
  • Push event: 1
  • Fork event: 1

Dependencies

requirements.txt pypi
  • pre-commit *
  • pytest *
environment.yml conda
  • pre-commit
  • pytest