Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Files organization
interactive dialogs
- `support/` - various support modules, e.g. for git/git-annex interfaces,
constraints for the `interface/`, etc
- `docs/` - yet to be heavily populated documentation
- `docs/` - sphinx documentation
- `bash-completions` - bash and zsh completion setup for reproman (just
`source` it)
- `tools/` contains helper utilities used during development, testing, and
Expand Down
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ReproMan

[![Supports python version](https://img.shields.io/pypi/pyversions/datalad)](https://pypi.org/project/datalad/)
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
[![GitHub release](https://img.shields.io/github/release/ReproNim/reproman.svg)](https://GitHub.com/ReproNim/reproman/releases/)
[![PyPI version fury.io](https://badge.fury.io/py/reproman.svg)](https://pypi.python.org/pypi/reproman/)
[![Tests](https://github.com/ReproNim/reproman/workflows/Tests/badge.svg)](https://github.com/ReproNim/reproman/actions?query=workflow%3ATests)
Expand All @@ -13,14 +13,6 @@ 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

ReproMan is under rapid development. 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](CONTRIBUTING.md) if you are interested in
internals and/or contributing to the project.
Expand All @@ -29,7 +21,7 @@ internals and/or contributing to the project.

ReproMan requires Python 3 (>= 3.9).

## Linux'es and OSX (Windows yet TODO) - via pip
## Linux and OSX via pip

By default, installation via pip (`pip install reproman`) installs core functionality of reproman
allowing for managing datasets etc. Additional installation schemes
Expand All @@ -54,7 +46,7 @@ all necessary packages from that repository.

## Dependencies

Python 3.9+ **with header files** possibly needed to build some extensions without wheels. They are provided by `python3-dev` on
Python **with header files** possibly needed to build some extensions without wheels. They are provided by `python3-dev` on
debian-based systems or `python-devel` on Red Hat systems.

Our `setup.py` and corresponding packaging describes all necessary python dependencies.
Expand Down
17 changes: 0 additions & 17 deletions docs/source/background.rst

This file was deleted.

10 changes: 5 additions & 5 deletions docs/source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ and API, and provides additional references where to seek more information
:sorted:

container
TODO Docker_ and Singularity_
A lightweight, portable runtime environment that packages an application with its dependencies. ReproMan supports Docker_ and Singularity_ containers for reproducible execution across different systems.

package
TODO
A software component or library that can be installed and managed within a computational environment. ReproMan can track and reproduce package installations across different resource types.

environment
TODO
A configured computational context with specific software, libraries, and settings. ReproMan creates and manages environments on various resources to ensure reproducible execution of scientific workflows.

virtual machine
TODO
A complete operating system running on virtualized hardware, providing strong isolation and reproducibility. ReproMan can create and manage VMs on cloud platforms like AWS.

cloud instance
TODO
A virtual server running on cloud infrastructure (such as AWS EC2) that can be dynamically created, configured, and destroyed. ReproMan uses cloud instances to provide scalable computational resources.

.. _Docker: http://docker.io
.. _Singularity: http://singularity.lbl.gov
3 changes: 0 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ Concepts and technologies
.. toctree::
:maxdepth: 2

background
related
usecases/index
glossary
sandbox/packages

Expand Down
15 changes: 0 additions & 15 deletions docs/source/related.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/usecases/index.rst

This file was deleted.

Loading