https://github.com/glotzerlab/signac-examples
Examples for the signac framework.
https://github.com/glotzerlab/signac-examples
hacktoberfest
Last synced: 11 months ago
JSON representation
Examples for the signac framework.
- Host: GitHub
- URL: https://github.com/glotzerlab/signac-examples
- Owner: glotzerlab
- License: bsd-3-clause
- Created: 2019-01-30T22:57:37.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T13:28:17.000Z (about 2 years ago)
- Last Synced: 2024-05-02T07:28:42.408Z (about 2 years ago)
- Topics: hacktoberfest
- Language: Jupyter Notebook
- Homepage: https://signac.io/
- Size: 1.42 MB
- Stars: 15
- Watchers: 10
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://mybinder.org/v2/gh/glotzerlab/signac-examples/main?filepath=notebooks%2F)
[](http://nbviewer.jupyter.org/github/glotzerlab/signac-examples/blob/main/notebooks/index.ipynb)
# signac - Tutorial and Examples
## Tutorial Notebooks
The [notebooks directory](notebooks/) contains a collection of Jupyter notebooks that serve as a tutorial.
They demonstrate how to implement a basic computational workflow using the [signac framework](https://signac.readthedocs.io/).
The framework assists users in managing simple to complext data spaces for example by simplifying provenance tracking and meta data management.
Use [nbviewer](http://nbviewer.jupyter.org) to view a [static version](http://nbviewer.jupyter.org/github/glotzerlab/signac-examples/blob/main/notebooks/index.ipynb) of these notebooks.
Or start a [dynamic version](https://mybinder.org/v2/gh/glotzerlab/signac-examples/main?filepath=notebooks%2Findex.ipynb) with the service offered by [mybinder.org](https://mybinder.org/).
To run the notebooks locally, clone the repository and then start Jupyter:
```bash
git clone https://github.com/glotzerlab/signac-examples.git
cd signac-examples/notebooks
jupyter lab # or jupyter notebook
# Open `index.ipynb` in your Jupyter session
```
Note that some notebooks have dependencies beyond Jupyter, signac, and signac-flow, like the HOOMD-blue simulation tutorial. A full conda environment containing these dependencies can be installed with:
```bash
conda env create -f environment.yml --name signac-examples
```
## Example Projects
The [projects directory](projects/) contains a collection of project examples.
They are designed as examples and for the fast setup of new projects.
Simply clone or download this repository and copy all scripts into your signac project path, *e.g.*:
```bash
git clone https://github.com/glotzerlab/signac-examples.git
mkdir my_project
cd my_project
signac init MyProject
cp -r ../signac-examples/projects/flow.minimal/* ./
```
For more information, please see [projects/README.md](projects/README.md).
## Copyright Notice
All code as part of this repository is released under the **BSD 3-Clause** [license](LICENSE.txt), except for the examples found in the *projects/* directory which are released into the [public domain](projects/LICENSE.txt).