Giter Site home page Giter Site logo

jmorim / pyopenms-docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from openms/pyopenms-docs

0.0 0.0 0.0 50.52 MB

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.

Home Page: https://pyopenms.readthedocs.io

License: Other

Shell 0.15% JavaScript 10.73% Python 87.48% CSS 0.72% HTML 0.92%

pyopenms-docs's Introduction

Documentation Status Build notebooks from master and push to master+ipynb Test code in notebooks

pyOpenMS Documentation

pyOpenMS are the Python bindings to the OpenMS open-source C++ library for LC-MS data management and analyses. The Python bindings cover a large part of the OpenMS API to enable rapid algorithm development and workflow development. pyOpenMS supports the Proteomics Standard Initiative (PSI) formats for MS data.

This repository contains documentation, installation instructions and example code that show different functions of pyOpenMS.

Installation

Installation is best done through PyPI (the Python package index) where binary packages are provided for the release versions of OpenMS, covering Linux/Mac/Windows. Alternatively, it is available on (bio)conda.

For the brave nightly build can be found at our local PyPI server.

Documentation

The readthedocs pyOpenMS documentation is generated from the master branch of this repository, see docs/README.md

The generated documentation is available here: https://pyopenms.readthedocs.io/en/latest/

Jupyter Notebooks

Are created by CI and stored in master+ipynb to not clutter the master branch.

Binder integration

Binder uses the Jupyter Notebooks in master+ipynb. The conda environment is described in environment.yml, the post-build event installs the nightly pyopenms wheel. Currently, only environment.yml is used by binder. Note: You can test a branch "jpfeuffer-patch-6" using https://mybinder.org/v2/gh/OpenMS/pyopenms-docs/jpfeuffer-patch-6

pyopenms-docs's People

Contributors

timosachsenberg avatar jpfeuffer avatar hroest avatar axelwalter avatar jangjang3 avatar jeeh-k avatar greengypsy avatar rahul799 avatar poshul avatar leon-bichmann avatar matteopilz avatar oliveralka avatar happy-reindeer007 avatar eeko-kon avatar kazoni avatar ayesha-feroz avatar enetz avatar hillengas avatar kyowonjeong avatar vipul-bajaj avatar wyrdrawere avatar arslan-siraj avatar jcharkow avatar kastakin avatar tapaswenipathak avatar tjeerdijk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.