-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* fix broken links * fix broken links * relink developer quickstart guide * update TOPPView intensity mode description * update tutorials * remove duplicated tutorial * reordered sections * download fix * major restructure * fixed installation cross ref * updated knime tutorial references * fixed warnings * fixed download link * fixed links * fixed links --------- Co-authored-by: Samuel Wein <[email protected]>
- Loading branch information
1 parent
8f1c156
commit 99c9232
Showing
268 changed files
with
4,048 additions
and
2,133 deletions.
There are no files selected for viewing
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
100 changes: 50 additions & 50 deletions
100
docs/images/installations/linux_logo.svg → docs/_images/installations/linux_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Oops, something went wrong.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
Community | ||
========= | ||
|
||
Welcome to OpenMS! | ||
------------------ | ||
|
||
OpenMS is a community-driven open source project developed by a diverse group of [contributors](https://openms.de/contributors/). The OpenMS leadership has made a strong commitment to creating an open, inclusive, and positive community. Please read the [OpenMS Code of Conduct](https://github.com/OpenMS/OpenMS/blob/develop/CODE_OF_CONDUCT.md) for guidance on how to interact with others in a way that makes the community thrive. | ||
|
||
Here's how to get started: | ||
|
||
- 📚 Browse through the main library code under [OpenMS/OpenMS](https://github.com/openms/openms/issues) | ||
- 👩💻 Check out the [documentation](https://openms.readthedocs.io/en/latest/index.html). | ||
- 🙋♀️ Come and say hi on our [![Discord Shield](https://img.shields.io/discord/832282841836159006?style=flat-square&message=Discord&color=5865F2&logo=Discord&logoColor=FFFFFF&label=Discord)](https://discord.gg/4TAGhqJ7s5) or [![Gitter](https://img.shields.io/static/v1?style=flat-square&message=on%20Gitter&color=ED1965&logo=Gitter&logoColor=FFFFFF&label=Chat)](https://gitter.im/OpenMS/OpenMS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) channels. | ||
- 🍿 Tune in for news about developer/user meetings and events, [get involved](https://openms.de/news/)! | ||
- 🌈 Please abide by our [community code of conduct](https://github.com/OpenMS/OpenMS/blob/develop/CODE_OF_CONDUCT.md) | ||
|
||
We offer several communication channels to learn, share your knowledge and connect with others within the OpenMS community. | ||
|
||
*** | ||
|
||
### <a class="button cta rounded primary-btn raised" href="https://discord.gg/aJyWqf6uCn">Discord</a> | ||
|
||
Discord allows the users to communicate in different channels, publicly as well as privately | ||
|
||
*** | ||
|
||
### <a class="button cta rounded primary-btn raised" href="https://github.com/openms">GitHub</a> | ||
|
||
The following repositories can be used: | ||
- [OpenMS](https://github.com/OpenMS/OpenMS) (Bug Reports, Feature requests) | ||
- [OpenMS-docs](https://github.com/OpenMS/OpenMS-docs) (Documentation-related issues) | ||
- [OpenMS.de](https://github.com/OpenMS/openms.de) (Any issue related to website) | ||
- [pyopenms-docs](https://github.com/OpenMS/pyopenms-docs) (Any issue related to pyopenms) | ||
|
||
In case if you are confused, please ask your query [here](https://openms.de/help-request/) | ||
|
||
*** | ||
|
||
### <a class="button cta rounded primary-btn raised" href="https://github.com/openms/openms/issues">GitHub issue tracker</a> | ||
|
||
The issue tracker can be used for: | ||
|
||
OpenMS | ||
- [Bug reports](https://github.com/OpenMS/OpenMS/labels/bug) (e.g. "Filter doesn't work for 1D data") | ||
- [Feature requests](https://github.com/OpenMS/OpenMS/labels/enhancement) | ||
- [Tools](https://github.com/OpenMS/OpenMS/issues?q=is%3Aopen+is%3Aissue+label%3ATOPP) (**T**he **O**penMS **P**i**p**eline - TOPP) | ||
- [TOPPView](https://github.com/OpenMS/OpenMS/labels/TOPPView) | ||
|
||
Documentation | ||
- [Bug reports](https://github.com/OpenMS/OpenMS-docs/labels/bug) | ||
- [Feature requests](https://github.com/OpenMS/OpenMS-docs/labels/enhancement) | ||
|
||
*** | ||
|
||
### <a class="button cta rounded primary-btn raised" href="https://gitter.im/OpenMS/OpenMS">Gitter</a> | ||
|
||
A real-time chat room to ask questions about OpenMS. | ||
|
||
*** | ||
|
||
### <a class="button cta rounded primary-btn raised" href="https://sourceforge.net/p/open-ms/mailman/open-ms-announcements">OpenMS mailing list</a> | ||
|
||
|
||
These lists are the main form of receiving OpenMS-related updates, like new features, changes to the roadmap, and all kinds of project-wide decision making. | ||
|
||
There are two mailing list currently: | ||
- [open-ms-announcements](https://sourceforge.net/p/open-ms/mailman/open-ms-announcements/) - Announcements about OpenMS, such as for releases, developer meetings, sprints or conference talks are made on this list. | ||
- [open-ms-general](https://sourceforge.net/p/open-ms/mailman/open-ms-general/) - For addressing any queries or suggestion from the users. | ||
|
||
*** | ||
|
||
### <a class="button cta rounded primary-btn raised" href="https://x.com/OpenMSTeam">Twitter</a> | ||
|
||
Contact us or just follow the latest OpenMS news on Twitter. | ||
|
||
*** | ||
|
||
Join the OpenMS Community | ||
------------------------- | ||
|
||
To thrive, the OpenMS project needs your expertise and enthusiasm. Not a coder? Not a problem! There are many ways to contribute to OpenMS. | ||
|
||
If you are interested in becoming a OpenMS contributor (yay!) we recommend checking out our [Contribute](/manual/contribute.md) page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
Installation | ||
============ | ||
|
||
.. toctree:: | ||
:hidden: | ||
|
||
installation/installation-on-gnu-linux.md | ||
installation/installation-on-macos.md | ||
installation/installation-on-windows.md | ||
|
||
Workflow Editor | ||
--------------- | ||
|
||
You can run OpenMS TOPP tools from the command line using your custom scripts, or use powerful | ||
workflow systems designed to make workflow creation and maintenance more fun, find out more in :ref:`workflows`. | ||
|
||
.. list-table:: | ||
:widths: 25 25 25 25 | ||
:class: borderless only-light | ||
:align: center | ||
|
||
* - .. image:: /_images/introduction/KNIMELogoTM.svg | ||
:target: ../getting-started/knime-get-started.html | ||
:width: 90% | ||
|
||
- .. image:: /_images/introduction/nextflow2014_no-bg.png | ||
:target: ../getting-started/nextflow-get-started.html | ||
:width: 90% | ||
|
||
- .. image:: /_images/introduction/galaxy_project_logo.png | ||
:target: ../getting-started/galaxy-get-started.html | ||
:width: 90% | ||
|
||
- .. image:: /_images/introduction/TOPPAS_logo_white.png | ||
:target: ../getting-started/toppas-get-started.html | ||
:width: 90% | ||
|
||
|
||
.. list-table:: | ||
:widths: 25 25 25 25 | ||
:class: borderless only-dark | ||
:align: center | ||
|
||
* - .. image:: /_images/introduction/KNIMELogoTM_white.svg | ||
:target: ../getting-started/knime-get-started.html | ||
:width: 90% | ||
|
||
- .. image:: /_images/introduction/nextflow2014_no-bg-bright.png | ||
:target: ../getting-started/nextflow-get-started.html | ||
:width: 90% | ||
|
||
- .. image:: /_images/introduction/galaxy_project_logo_white.png | ||
:target: ../getting-started/galaxy-get-started.html | ||
:width: 90% | ||
|
||
- .. image:: /_images/introduction/TOPPAS_logo_dark.png | ||
:target: ../getting-started/toppas-get-started.html | ||
:width: 90% | ||
|
||
|
||
Graphical and Command-Line Tools | ||
-------------------------------- | ||
For instructions on how to install the OpenMS graphical and command-line tools, choose your operating system | ||
from the items below. | ||
|
||
|
||
.. grid:: | ||
:gutter: 4 | ||
|
||
.. grid-item-card:: GNU/Linux | ||
:img-top: /_images/installations/linux_logo.svg | ||
:link: installation/installation-on-gnu-linux | ||
:link-type: doc | ||
:columns: 4 | ||
|
||
Installation on Linux | ||
|
||
.. grid-item-card:: macOS | ||
:img-top: /_images/installations/macos_logo.svg | ||
:link: installation/installation-on-macos | ||
:link-type: doc | ||
:columns: 4 | ||
|
||
Installation on macOS | ||
|
||
.. grid-item-card:: Windows | ||
:img-top: /_images/installations/Windows_logo.svg | ||
:link: installation/installation-on-windows | ||
:link-type: doc | ||
:columns: 4 | ||
|
||
Installation on Windows |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
...s/installation/installation-with-conda.md → ...t/installation/installation-with-conda.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
# Conda | ||
|
||
% start-after | ||
## Install via Conda | ||
|
||
```{warning} | ||
|
3 changes: 3 additions & 0 deletions
3
...nd-tools/installation/run-in-container.md → docs/about/installation/run-in-container.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.