========
locuaz
========
.. image:: https://img.shields.io/pypi/v/locuaz.svg
:target: https://pypi.python.org/pypi/locuaz
.. image:: https://readthedocs.org/projects/locuaz/badge/?version=latest
:target: https://locuaz.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
.. image:: https://zenodo.org/badge/502907107.svg
:target: https://zenodo.org/doi/10.5281/zenodo.10937388
Looping Uniquely Catered Amino Acid Sequences
* Free software: MIT license
* Documentation: https://locuaz.readthedocs.io.
Install
--------
Create a conda environment YAML file named, for example, ``usr_deps.yaml``::
name: locuaz
channels:
- conda-forge
dependencies:
- conda-forge::python>=3.10
- conda-forge::ambertools>=22.0.0
- conda-forge::tensorflow
- conda-forge::openbabel
- conda-forge::pygraphviz
by running:
.. code-block:: console
mamba env create -f usr_deps.yaml
Then, activate the environment and install the protocol through pip:
.. code-block:: console
pip install locuaz
Check the `Installation`_ section on the docs for more info.
Post-Install
-------------
Using DLPacker based mutators
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you wish to used *DLPacker* based *Mutators* (``dlp`` and ``dlpr``), DLPacker weights have to be downloaded.
Get them `here <https://drive.google.com/file/d/1J4fV9aAr2nssrWN8mQ7Ui-9PVQseE0LQ/view?usp=sharing>`_
or `here`_. These weights have to be extracted to a dedicated folder and its path has to be specified in the
input config under the ``paths`` key, on the ``mutator`` option. Check the `docs`_ for more info.
Running
-------
After that, running *locauz* is as simple as:
.. code-block:: console
# Activate your environment
mamba activate locuaz
# Point locuaz to your config file
locuaz config.yaml
Check the `tutorials`_ for info on how to write this config file.
.. _tutorials: https://locuaz.readthedocs.io/en/latest/tutorialsimple.html
Citing
-------
Credits
-------
- `Biobb <https://mmb.irbbarcelona.org/biobb/documentation/source>`_
- `MDAnalysis <https://github.com/MDAnalysis/mdanalysis>`_
- `FreeSASA <https://github.com/freesasa/freesasa-python>`_
.. _docs: https://locuaz.readthedocs.io/en/latest/mutators.html
.. _Installation: https://locuaz.readthedocs.io/en/latest/installation.html
MIT License
Copyright (c) [2023] [Patricio Barletta]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "locuaz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "molecular, dynamics, antibody, antibodies",
"author": "Patricio Barletta",
"author_email": "pbarletta@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ee/87/80963b9809584f95718a0c6ff9dab85f2cd597caa9ec662069a23a83c4c0/locuaz-0.7.5.4.tar.gz",
"platform": null,
"description": "========\nlocuaz\n========\n\n\n.. image:: https://img.shields.io/pypi/v/locuaz.svg\n :target: https://pypi.python.org/pypi/locuaz\n\n.. image:: https://readthedocs.org/projects/locuaz/badge/?version=latest\n :target: https://locuaz.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n.. image:: https://zenodo.org/badge/502907107.svg\n :target: https://zenodo.org/doi/10.5281/zenodo.10937388\n\nLooping Uniquely Catered Amino Acid Sequences\n\n* Free software: MIT license\n* Documentation: https://locuaz.readthedocs.io.\n\nInstall\n--------\n\nCreate a conda environment YAML file named, for example, ``usr_deps.yaml``::\n\n name: locuaz\n channels:\n - conda-forge\n dependencies:\n - conda-forge::python>=3.10\n - conda-forge::ambertools>=22.0.0\n - conda-forge::tensorflow\n - conda-forge::openbabel\n - conda-forge::pygraphviz\n\nby running:\n\n.. code-block:: console\n\n mamba env create -f usr_deps.yaml\n\nThen, activate the environment and install the protocol through pip:\n\n.. code-block:: console\n\n pip install locuaz\n\nCheck the `Installation`_ section on the docs for more info.\n\n\nPost-Install\n-------------\n\nUsing DLPacker based mutators\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIf you wish to used *DLPacker* based *Mutators* (``dlp`` and ``dlpr``), DLPacker weights have to be downloaded.\nGet them `here <https://drive.google.com/file/d/1J4fV9aAr2nssrWN8mQ7Ui-9PVQseE0LQ/view?usp=sharing>`_\nor `here`_. These weights have to be extracted to a dedicated folder and its path has to be specified in the\ninput config under the ``paths`` key, on the ``mutator`` option. Check the `docs`_ for more info.\n\n\nRunning\n-------\n\nAfter that, running *locauz* is as simple as:\n\n\n.. code-block:: console\n\n # Activate your environment\n mamba activate locuaz\n # Point locuaz to your config file\n locuaz config.yaml\n\nCheck the `tutorials`_ for info on how to write this config file.\n\n.. _tutorials: https://locuaz.readthedocs.io/en/latest/tutorialsimple.html\n\nCiting\n-------\n\n\n\nCredits\n-------\n\n- `Biobb <https://mmb.irbbarcelona.org/biobb/documentation/source>`_\n- `MDAnalysis <https://github.com/MDAnalysis/mdanalysis>`_\n- `FreeSASA <https://github.com/freesasa/freesasa-python>`_\n\n.. _docs: https://locuaz.readthedocs.io/en/latest/mutators.html\n.. _Installation: https://locuaz.readthedocs.io/en/latest/installation.html\n\n\nMIT License\n\nCopyright (c) [2023] [Patricio Barletta]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": null,
"summary": "Antibody optimization protocol",
"version": "0.7.5.4",
"project_urls": null,
"split_keywords": [
"molecular",
" dynamics",
" antibody",
" antibodies"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1df46ac117c2d22870d5e454cf550316062dbeb1b2e6ac67859ac07ecd62a887",
"md5": "cb61b9d67ae795df640b2c72d60c001c",
"sha256": "654af17d08dad0fc606290d7c2761261ccdea5d3c3a3d4b20f229943a4c5866f"
},
"downloads": -1,
"filename": "locuaz-0.7.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb61b9d67ae795df640b2c72d60c001c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 70297140,
"upload_time": "2024-07-08T16:11:27",
"upload_time_iso_8601": "2024-07-08T16:11:27.669724Z",
"url": "https://files.pythonhosted.org/packages/1d/f4/6ac117c2d22870d5e454cf550316062dbeb1b2e6ac67859ac07ecd62a887/locuaz-0.7.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee8780963b9809584f95718a0c6ff9dab85f2cd597caa9ec662069a23a83c4c0",
"md5": "df1aae711f86b00b4a861d35bbe05753",
"sha256": "7ca643d2b266392ebf3f94a8424e5c758c7e44875497598da4c95747ebb167dd"
},
"downloads": -1,
"filename": "locuaz-0.7.5.4.tar.gz",
"has_sig": false,
"md5_digest": "df1aae711f86b00b4a861d35bbe05753",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 70249143,
"upload_time": "2024-07-08T16:11:33",
"upload_time_iso_8601": "2024-07-08T16:11:33.302027Z",
"url": "https://files.pythonhosted.org/packages/ee/87/80963b9809584f95718a0c6ff9dab85f2cd597caa9ec662069a23a83c4c0/locuaz-0.7.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 16:11:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "locuaz"
}
JSON