template-for-supporting-information
Template for Notebooks for Supporting Information and Zenodo Deposition
https://github.com/mlund/template-for-supporting-information
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
Template for Notebooks for Supporting Information and Zenodo Deposition
Basic Info
Statistics
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Electronic Notebook: Title goes here
Template for Notebooks for Supporting Information and Zenodo Deposition.
Instruction video
Layout
Description of the directory layout.
README.mdThis is the file you're viewing right now.environment.ymlDefines the required Python packages using conda. Try to pin to specific major versions of your dependencies as their behavior may change in the future. The environment is currently calledmy_environmentand you'll likely want to rename it to something less generic..zenodo.jsonmetadata for Zenodo.pyproject.tomlandgithub/workflows/ruff.ymlsets up ruff linting for Python and Jupyter Notebooks. Delete if not relevant to your project.
Requirements
To run the Notebooks online, click on the Launch Binder badge above. Alternatively, to run on your own computer, install Python using e.g. Miniforge or Anaconda and make sure all required packages are loaded by issuing the following terminal commands
bash
conda env create -f environment.yml
source activate my_environment
jupyter-lab
Checklist - delete before publishing
- [ ] Add authors incl. ORCID's and other relevant metadata to
.zenodo.json; to learn more about the available datafields, see here. Before publishing, validate the JSON file using the Zenodo deposition schemalegacyrecord.jsonwith e.g.bash pip install check-jsonschema check-jsonschema --schemafile https://raw.githubusercontent.com/zenodo/zenodo/master/zenodo/modules/deposit/jsonschemas/deposits/records/legacyrecord.json .zenodo.json - [ ] Update Binder badge to point to your repository
- [ ] Add the Github repo link and DOI of the associated publication to
.zenodo.jsonunderrelated_identifiers. - [ ] Update
environment.ymlto include required packages. Select name for environment. - [ ] If needed, change the license (
LICENSEand badge inREADME.md), see e.g. Creative Commons alternatives - [ ] Activate Github tracking of the repository on https://zenodo.org. Repository must be public.
- [ ] Create a release on Github - adhere to SemVer. This triggers a deposition on Zenodo.
- [ ] Once you get the Zenodo DOI, add a badge to the top if this README. Use link to all versions.
- [ ] Feel free to update and make new releases!
Owner
- Name: Mikael Lund
- Login: mlund
- Kind: user
- Location: Lund, Sweden
- Company: Lund University
- Website: www.teokem.lu.se/~mikael
- Repositories: 32
- Profile: https://github.com/mlund
GitHub Events
Total
- Fork event: 1
Last Year
- Fork event: 1
Committers
Last synced: 11 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Mikael Lund | m****d@m****m | 19 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
Dependencies
- actions/checkout v4 composite
- jpetrucciani/ruff-check main composite