Skip to content

Update the documentation for the new modelarchive-py based validator #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bienchen wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the documentation for the new modelarchive-py based validator #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@ ModelCIF data standards are used or supported by various model repositories (e.g
and visualization software (e.g. [Mol*](https://molstar.org/), [ChimeraX](https://www.cgl.ucsf.edu/chimerax/)).

The [python-modelcif](https://github.com/ihmwg/python-modelcif) library facilitates the programmatic
creation of ModelCIF files and includes convenience classes to streamline this process. A collection
of ModelCIF conversion scripts, mostly based on python-modelcif, as well as a ModelCIF validation tool
based on [RCSB's CifCheck](https://github.com/rcsb/cpp-dict-pack), are available in a dedicated
[modelcif-converters](https://git.scicore.unibas.ch/schwede/modelcif-converters/) code repository
maintained by the ModelArchive team.
creation of ModelCIF files and includes convenience classes to streamline this process. A collection of ModelCIF conversion scripts, built on top of the [modelarchive-py](https://pypi.org/project/modelarchive-py/) Python package, are available in a
dedicated [modelcif-converters](https://git.scicore.unibas.ch/schwede/modelcif-converters/) code repository maintained by the ModelArchive team. The [modelarchive-py](https://pypi.org/project/modelarchive-py/) package also provides a
ModelCIF validation tool based on [RCSB's CifCheck](https://github.com/rcsb/cpp-dict-pack); see the
[validator documentation](https://modelarchive-py.readthedocs.io/stable/tools.html#module-modelarchive.tools.validator) for details.

[ModelCIF](dist/mmcif_ma.dic) is an extension of the [PDBx/mmCIF](http://mmcif.wwpdb.org)
dictionary. The [PDBx/mmCIF](http://mmcif.wwpdb.org) dictionary is used by the [wwPDB](http://www.wwpdb.org) to
Expand Down
8 changes: 6 additions & 2 deletions dictionary_documentation/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -820,8 +820,12 @@ Tools to handle ModelCIF files:

- [python-modelcif](https://github.com/ihmwg/python-modelcif) to create ModelCIF files
- [PDBx/mmCIF Software Resources](https://mmcif.wwpdb.org/docs/software-resources.html) to read and modify any type of mmCIF file
- [modelcif-converters](https://git.scicore.unibas.ch/schwede/modelcif-converters/) include ModelCIF conversion scripts used for depositions in [ModelArchive](https://modelarchive.org/). These scripts are mostly based on python-modelcif. There is also a ModelCIF validation tool
based on [RCSB's CifCheck](https://github.com/rcsb/cpp-dict-pack) in the repository.
- [modelcif-converters](https://git.scicore.unibas.ch/schwede/modelcif-converters/) includes ModelCIF
conversion scripts used for depositions in [ModelArchive](https://modelarchive.org/), built on top
of the [modelarchive-py](https://pypi.org/project/modelarchive-py/) Python package.
- [modelarchive-py](https://pypi.org/project/modelarchive-py/) also provides a ModelCIF validation tool based on
[RCSB's CifCheck](https://github.com/rcsb/cpp-dict-pack); see the
[validator documentation](https://modelarchive-py.readthedocs.io/stable/tools.html#module-modelarchive.tools.validator) for details.

Modeling services and repositories known to contain or produce valid ModelCIF files:
[ModelArchive](https://www.modelarchive.org),
Expand Down