Mercurial > repos > iuc > swissmodel_modelling_api

annotate README.rst @ 0:fdee06ed645e draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
author iuc
date Thu, 11 Dec 2025 19:32:01 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
1 ============================================
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
2 SWISS-MODEL Modelling API Galaxy integration
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
3 ============================================
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
4
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
5 This is a wrapper for the
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
6 `SWISS-MODEL API <https://swissmodel.expasy.org/docs/help#modelling_api>`_.
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
7
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
8 `SWISS-MODEL <https://swissmodel.expasy.org/>`_ is a web-based integrated
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
9 service dedicated to protein structure homology modelling.
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
10
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
11 With the API wrapper, you are able to build protein models
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
12
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
13 - fully automated (Automodel mode)
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
14 - for a specific alignment provided by the user (Alignment mode)
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
15 - based on user provider template coordinates (User template mode)
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
16
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
17 Models can be created in ModelCIF format and legacy PDB format.
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
18
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
19 Documentation on how to use the tool inside Galaxy is in the tool XML file.
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
20
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
21 Installation
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
22 ------------
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
23
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
24 Needs Python (>=3.11) and the Python requests package (2.32.5).
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
25
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
26 Attribution
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
27 -----------
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
28
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
29 When you publish or report results using SWISS-MODEL, please cite the relevant
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
30 publications found on https://swissmodel.expasy.org/docs/references (and on the
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
31 Galaxy tool page, once installed).
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
32
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
33 License
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
34 -------
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
35
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
36 License of this Galaxy tool wrapper can be found in `LICENSE <LICENSE>`_.
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
37
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
38 Terms of use of the SWISS-MODEL server can be found at
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
39 https://swissmodel.expasy.org/docs/terms_of_use.
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
40
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
41 Modelling results of SWISS-MODEL are licensed under the
fdee06ed645e planemo upload for repository https://github.com/galaxyproject/tools-iuc/main/tools/swissmodel_modelling_api commit 43b5bef8757185b4c077effd0bad846f25d408db
iuc
parents:
diff changeset
42 `CC BY-SA 4.0 Creative Commons Attribution-ShareAlike 4.0 International License <https://creativecommons.org/licenses/by-sa/4.0/legalcode>`_.