StochSS / sciope

Python3 Toolkit for ML-assisted inference, optimization and parameter exploration.
Other
15 stars 11 forks source link

Sciope logo

Build Status codecov License

README

Scalable inference, optimization and parameter exploration (sciope) is a Python 3 package for performing machine learning-assisted inference and model exploration by large-scale parameter sweeps. Please see the documentation for examples.

What can the sciope toolbox do?

How do I get set up?

Please see the documentation for instructions to install and examples. The easiest way to start using Sciope is through the StochSS online platform (https://app.stochss.org).

Steps to a successful contribution

  1. Fork Sciope (https://help.github.com/articles/fork-a-repo/)
  2. Make the changes to the source code in your fork.
  3. Check your code with PEP8 or pylint. Please limit text to 80 columns wide.
  4. Each feature or bugfix commit should consist of the corresponding code, tests, and documentation.
  5. Create a pull request to the develop branch in Sciope.
  6. Please feel free to use the comments section to communicate with us, and raise issues as appropriate.
  7. The pull request gets accepted and your new feature will soon be integrated into Sciope!

Who do I talk to?

Citing Sciope

To cite Sciope, please reference the Bioinformatics application note. Sample Bibtex is given below:

@article{sciope,
    author = {Singh, Prashant and Wrede, Fredrik and Hellander, Andreas},
    title = "{Scalable machine learning-assisted model exploration and inference using Sciope}",
    journal = {Bioinformatics},
    year = {2020},
    month = {07},
    issn = {1367-4803},
    doi = {10.1093/bioinformatics/btaa673},
    url = {https://doi.org/10.1093/bioinformatics/btaa673},
    note = {btaa673},
    eprint = {https://academic.oup.com/bioinformatics/advance-article-pdf/doi/10.1093/bioinformatics/btaa673/33529616/btaa673.pdf},
}