Neuroimaging Computational Environments Manager (NICEMAN) (AKA ReproNim TRD3)
Python
Switch branches/tags
Nothing to show
Latest commit ba48bf3 Jan 18, 2018 @yarikoptic yarikoptic Merge pull request #159 from yarikoptic/enh-docker-fixture
RF: Refactor setup_ssh into a generic get_docker_fixture
Permalink
Failed to load latest commit information.
docs BF(DOC)+workaround: allow for sphinx syntax errors (hierarchy.rst) an… Jul 17, 2017
niceman Merge pull request #159 from yarikoptic/enh-docker-fixture Jan 18, 2018
tools allow downgrades Sep 12, 2017
.gitignore RF: repronim -> niceman #1 Jan 12, 2017
.travis.yml Merge branch 'master' into bf-docker-fixture Nov 21, 2017
CHANGELOG.md make it 0.0.5 altogether since pypi refuses to reupload 0.0.4 Jan 6, 2018
CONTRIBUTING.md BF: Quick fix to install documentation Dec 5, 2017
COPYING RF: repronim -> niceman #2 Jan 12, 2017
Dockerfile ENH: Changed source apt build to start with sources instead of packages. Dec 21, 2017
README.md RF: repronim -> niceman #2 Jan 12, 2017
Singularity Adding initial Singularity file for setting up "development" env Jun 13, 2017
docker-compose.yml ENH: Changed source apt build to start with sources instead of packages. Dec 21, 2017
formatters.py RF(first wave): .distribution -> .distributions, .provenance -> .formats May 18, 2017
niceman.cfg ENH: Changed source apt build to start with sources instead of packages. Dec 21, 2017
readthedocs.yml ENH: copied materials from datalad@8f17d6c to take advantage of RFing… Oct 17, 2016
requirements-devel.txt ENH: copied materials from datalad@8f17d6c to take advantage of RFing… Oct 17, 2016
requirements.txt RF: repronim -> niceman #1 Jan 12, 2017
setup.cfg RF: repronim -> niceman #1 Jan 12, 2017
setup.py adjusted the description and provided long description from README Jan 6, 2018
setup_support.py RF: repronim -> niceman #2 Jan 12, 2017
tox.ini BF: use py.test within tox, no explicit depends on python-apt in setu… Jan 30, 2017

README.md

NICEMAN

NICEMAN aims to simplify creation and management of computing environments in Neuroimaging. While concentrating on Neuroimaging use-cases, it is by no means is limited to this field of science and tools will find utility in other fields as well.

Status

NICEMAN is under initial rapid development to establish core functionality. While the code base is still growing the focus is increasingly shifting towards robust and safe operation with a sensible API. There has been no major public release yet, as organization and configuration are still subject of considerable reorganization and standardization.

See CONTRIBUTING.md if you are interested in internals and/or contributing to the project.

Code status:

  • Travis tests status travis-ci.org (master branch)

  • codecov.io

  • Documentation

Installation

Debian-based systems

On Debian-based systems we recommend to enable NeuroDebian from which we will soon provide recent releases of NICEMAN (as soon as there is something to release). We will also provide backports of all necessary packages from that repository.

Other Linux'es, OSX (Windows yet TODO) via pip

By default, installation via pip installs core functionality of niceman allowing for managing datasets etc. Additional installation schemes are available, so you could provide enhanced installation via pip install niceman[SCHEME] where SCHEME could be

  • tests to also install dependencies used by unit-tests battery of the niceman
  • full to install all of possible dependencies.

For installation through pip you would need some external dependencies not shipped from it (e.g. docker, singularity, etc.) for which please refer to the next section.

Dependencies

Our setup.py and corresponding packaging describes all necessary dependencies. On Debian-based systems we recommend to enable NeuroDebian since we use it to provide backports of recent fixed external modules we depend upon. Additionally, if you would like to develop and run our tests battery see CONTRIBUTING.md regarding additional dependencies.

Later we will provide bundled installations of NICEMAN across popular platforms.

License

MIT/Expat

Disclaimer

It is in a alpha stage -- nothing is set in stone yet and nothing is usable ATM -- subscribe and wait for the first release.