/cancer-detective

A simulation to learn about cancer and mutations, based on Cancer Genome Interpreter

Primary LanguageJupyter NotebookOtherNOASSERTION

Cancer Detective

An analysis simulation based on Cancer Genome Interpreter, for an educational purpose.

Installation

It is recommended to use Conda or any other type of environment, but not required.

conda create --name cancer-detective
conda activate cancer-detective
conda install pip
pip install -r requirements.txt
python3 setup.py develop

Usage

Running the website:

python3 web.py

The website should be accessible by going in your browser to http://localhost:8080/

Running as cli:

play -c [lung/skin]

or see help:

play --help

Configuration

In the conf folder you can create a file named game.cfg or you can pass a different location to the script:

python3 web.py /path/to/game.cfg

This configuration file can be used to tweak the server and the application configuration. Take a look at the conf/game.spec.cfg file for further details.

Contributing

Feel free to contribute as much as you want to the code.

See CONTRIBUTING for guidelines on contributing and respect your behaviour specified at CODE OF CONDUCT.

For more information, see also How to Contribute to Open Source.

License

The software is licensed under GNU-GPLv3, and the the artworks in the images folder are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.