Artemis is a collection of tools that make it easier to run experiments in Python. These include:
- An easy-to-use system for making live plots, to monitor variables in a running experiment.
- A browser-based plotter for displaying live plots.
- A framework for defining experiments and logging their results (text output and figures) so that they can be reviewed later and replicated easily.
- A system for downloading/caching files, to a local directory, so the same code can work on different machines.
To use artemis from within your project, use the following to install Artemis and its dependencies: (You probably want to do this in a virtualenv with the latest version of pip - run virtualenv venv; source venv/bin/activate; pip install --upgrade pip;
to make one and enter it).
pip install -e git+http://github.com/QUVA-Lab/artemis.git#egg=artemis
This will install it in (virtual env or system python root)/src/artemis
. You can edit the code and submit pull requests to our git repo. To install with the optional remote plotting mode enabled, add the [remote_plotting]
option, as in: pip install -e git+http://github.com/QUVA-Lab/artemis.git#egg=artemis[remote_plotting]
pip install artemis-ml
To verify that the plotting works, run:
python -m artemis.plotting.demo_dbplot
A bunch of plots should come up and start updating live.
Note: During installation, the settings file .artemisrc
is created in your home directory. In it you can specify the plotting backend to use, and other settings.
Live Plotting: /artemis/plotting/demo_dbplot.py
Recording Experiment Results: artemis/experiments/demo_experiments.py
A demo repo showing how to use Artemis from your code: https://github.com/QUVA-Lab/demo_repo
After installing, you should have a file ~/.artemis rc. To use the web backend, edit the backend
field to matplotlib-web
. To try it you can run /artemis/plotting/demo_dbplot.py
If you like Artemis then you'll love Plato - a new API that simplifies the use of Theano.