Henry's tools in Python.
Project description
Scihence
Henry's tools for doing science.
Usage
Installation:
pip install scihence
Importing:
import scihence
Development
Workflow
graph TD;
changes(Make changes):::nodeclass-->document
document(Document):::nodeclass-->test
test(Test):::nodeclass-->passing
passing(Passing?):::nodeclass
passing--No-->changes
passing--Yes-->push
push(Push):::nodeclass-->review
review(Review):::nodeclass
review--Contributer-->approved
review--Reviewer-->env
approved(Approved?):::nodeclass
approved--No-->changes
approved--Yes-->merge
merge(Merge):::nodeclass-->version
version(Version):::nodeclass
env(Make environment):::nodeclass-->check
check(Also ensure tests pass):::nodeclass-->code
code(Check code):::nodeclass-->approved
classDef nodeclass fill:#000035, stroke:#c0c0c0, color:#c0c0c0;
linkStyle default fill:none, stroke:#c0c0c0,stroke-width:2px;
Setup
- Ensure
pyenv
is installed on your device. - Substituting the Python version, run the following code in the terminal at the root of the repository directory:
make env v=z.y.z && source .venv/bin/activate
Documentation
The live version of the documentation can be found here.
At each PR, you should ensure that you have followed the following steps to make sure the documentation is up-to-date:
- When adding a new object to an existing sub-package:
- this will simply only require writing the docstring for the required objects in the
.py
file, and then listing those objects that you would like to appear in the HTML documentation (i.e. those imported in the__init__.py
) in the relevantdocs/source/python-api/*.rst
file.
- this will simply only require writing the docstring for the required objects in the
- When adding a new sub-package (i.e. a new folder):
- this will require creating a new
docs/source/python-api/*.rst
whose format can be copied across from an existing one.
- this will require creating a new
Note: You should only ever need to edit the
docs/source/python-api/*.rst
files, and never anything inside any of the folders withindocs/source/python-api
, since these are auto-generated.
To build documentation, in your environment run the following code in the terminal at the root of the repository directory:
make doc
Tests
In your environment, run the following code in the terminal at the root of the repository directory, replacing and including python versions that are supported:
pyenv shell 3.a.b 3.c.d && tox
Versions
Note: Versioning should only occur for the master branch.
- Before merging, ensure that the version number listed in
src/scihence/__init__.py
is updated. - If multiple branches are currently in review, try to liaise with those PR owners to ensure that version numbers are updated accordingly before merging.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.