Development

Installation

Requirements

• Python 2.7 or 3.6
• Git

Pip

1. Fork the cytominer-database repository
2. Install the project and its dependencies:

   git clone [email protected]:USERNAME/cytominer-database.git
   cd cytominer-database
   pip install --upgrade --editable .
   

Tests

Pip

1. Install the project and test dependencies:

   pip install --upgrade --editable .[test]
   

2. Run the tests:

   pytest
   

   or an individual test:

   pytest tests/TEST_FILENAME.py
   

Documentation

Pip

1. Install the project and documentation dependencies:

   pip install --upgrade --editable .[doc]
   

2. Build the HTML documentation (Linux/OS X):

   cd doc
   make html
   

   Build the HTML documentation (Windows):

   cd doc
   .\make.bat html