opti-face :-)

A suite of tools for automating experiments in computational research.

Description

opti-face provides a robust, easy to implement, and hard-to-mess-up interface for a computational problem, any algorithms that may be used to solve it, and all data auxiliary to the process of analyzing them. Upon following the steps in Installation, a user will immediately have access to robust automations to run experiments, a secure database that automagically sets itself up, and a growing suite of post-processing tools.

Installation

Fork this opti-face, and clone it to your local machine.

git clone https://github.com/your-username/opti-face.git your-fork

Navigate to your local clone of your fork.

cd your-fork

Set up your local environment.

# using conda
conda env create -f requirements/environment.yml
conda activate opti-face

TODO: see pip environment issue.

# or using venv and pip

Complete your opti-fork implementation to-do list.

1. TODO: See fork instructions issue.

Usage

Contributing

See CONTRIBUTING.md.

Code of Conduct

See CODE_OF_CONDUCT.md.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

If you have any questions, please feel free to contact me at wrabetzluca@gmail.com.