<div align="center">
# ⌛️ smiffer 🦙
[](https://www.python.org/downloads/release/python-350/)
[](https://opensource.org/licenses/MIT)
<img src="docs/ressources/img/logo.png" width="40%">
Contributors: **Diego BARQUERO MORERA** and **Lucas ROUAUD**
**Documentation:** https://smiffer.mol3d.tech/
</div align="center">
This software is coded in python. It permits to produced grids, into a OpenDX format (`.dx`). With those grids, it is possible to visualize multiple physical and chemical properties around a protein. This permit to see all possible area of interaction (with proteins, ligands or lipids) around a protein.
## ⚙️ Installation
### 📦 Using pipx (recommended)
- pipx link: [https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx)
```bash
$ pipx install smiffer
# Checking the installation is done.
$ smiffer --help
```
> **🦊 From the GitLab repository:**
>
> ```bash
> $ git clone https://gitlab.galaxy.ibpc.fr/rouaud/smiffer.git
> $ cd smiffer/
> $ pipx install .
>
> # Checking the installation is done.
> $ smiffer --help
> ```
### 🐍 Using pip
```bash
$ python3 -m pip install smiffer
# Checking the installation is done.
$ smiffer --help
```
> **🦊 From the GitLab repository:**
>
> ```bash
> $ git clone https://gitlab.galaxy.ibpc.fr/rouaud/smiffer.git
> $ cd smiffer/
> $ python3 -m pip install .
>
> # Checking the installation is done.
> $ smiffer --help
> ```
### 🐋 Using docker
```bash
$
```
### 🛠 From scratch (not recommended)
```bash
$ git clone https://gitlab.galaxy.ibpc.fr/rouaud/smiffer.git
$ cd smiffer
# Install globaly these packages…
$ pip install -r env/requirements.txt
# Checking the installation is done.
$ python -m src.smiffer.main --help
```
## 🌐 External software
The APBS server can be found at next url: https://server.poissonboltzmann.org/.
## 🚀 Launching the software
### 🎥 Example
To test the program, use the following commands in `📁 smiffer/`:
```sh
$ mkdir data/output/
# Launching the software.
$ smiffer -i data1EHE.pdb \
$ -p data1EHE_parameter.yml \
$ -a data/1EHE_APBS.dx \
$ -o data/output/
# Visualize using VMD (or other like PyMol, Chimera, Mol*, etc.).
$ vmd data/1EHE.pdb data/output/*.dx
```
### 🔍 Parameters description
| **Argument** | **Mandatory?** | **Type and usage** | **Description** |
| :------------------------ | :------------: | :--------------------- | :--------------------------------------------------------------------------- |
| **`-i` or `--input`** | Yes | `--input file.pdb` | The `.pdb` file that while be used<br/>to computed the properties. |
| **`-o` or `--output`** | Yes | `--output directory` | The directory to output the results. |
| **`-p` or `--parameter`** | No | `--parameter file.yml` | The YAML parameters file. |
| **`-a` or `--apbs`** | No | `--apbs file.dx` | The already computed APBS<br/>electrostatic grid. |
| **`-h` or `--help`** | No | Flag | Display the help and exit the<br/>program. |
| **`-v` or `--version`** | No | Flag | Display the version and exit the<br/>program. |
| **`--verbose`** | No | Flag | Activated a verbose mode, so more<br/>information are going to be displayed. |
## 🙇♂️ Aknowledgement
🔍 Code reviewing: **Hubert Santuz**
_This work is licensed under a [MIT License](https://opensource.org/licenses/MIT)._
[](https://opensource.org/licenses/MIT)
Raw data
{
"_id": null,
"home_page": null,
"name": "smiffer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "Lucas ROUAUD <lucas.rouaud@gmail.com>",
"keywords": "python, chemical, grid, RNA, protein, properties, physical based computation, bioinformatic, chemoinformatic",
"author": null,
"author_email": "Diego BARQUERO MORERA <diegobarqueromorera@gmail.com>, Lucas ROUAUD <lucas.rouaud@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a4/b2/7337506678ff434726a01bbe09b5f3e06f2dc164139ad067f1d757b95c18/smiffer-0.0.3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# \u231b\ufe0f smiffer \ud83e\udd99\n\n[](https://www.python.org/downloads/release/python-350/)\n[](https://opensource.org/licenses/MIT)\n\n<img src=\"docs/ressources/img/logo.png\" width=\"40%\">\n\nContributors: **Diego BARQUERO MORERA** and **Lucas ROUAUD**\n\n**Documentation:** https://smiffer.mol3d.tech/\n\n</div align=\"center\">\n\nThis software is coded in python. It permits to produced grids, into a OpenDX format (`.dx`). With those grids, it is possible to visualize multiple physical and chemical properties around a protein. This permit to see all possible area of interaction (with proteins, ligands or lipids) around a protein.\n\n## \u2699\ufe0f Installation\n\n### \ud83d\udce6 Using pipx (recommended)\n\n- pipx link: [https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx)\n\n```bash\n$ pipx install smiffer\n\n# Checking the installation is done.\n$ smiffer --help\n```\n\n> **\ud83e\udd8a From the GitLab repository:**\n> \n> ```bash\n> $ git clone https://gitlab.galaxy.ibpc.fr/rouaud/smiffer.git\n> $ cd smiffer/\n> $ pipx install .\n> \n> # Checking the installation is done.\n> $ smiffer --help\n> ```\n\n### \ud83d\udc0d Using pip\n\n```bash\n$ python3 -m pip install smiffer\n\n# Checking the installation is done.\n$ smiffer --help\n```\n\n> **\ud83e\udd8a From the GitLab repository:**\n> \n> ```bash\n> $ git clone https://gitlab.galaxy.ibpc.fr/rouaud/smiffer.git\n> $ cd smiffer/\n> $ python3 -m pip install .\n> \n> # Checking the installation is done.\n> $ smiffer --help\n> ```\n\n### \ud83d\udc0b Using docker\n\n```bash\n$ \n```\n\n### \ud83d\udee0 From scratch (not recommended)\n\n```bash\n$ git clone https://gitlab.galaxy.ibpc.fr/rouaud/smiffer.git\n$ cd smiffer\n\n# Install globaly these packages\u2026\n$ pip install -r env/requirements.txt\n\n# Checking the installation is done.\n$ python -m src.smiffer.main --help\n```\n\n## \ud83c\udf10 External software\n\nThe APBS server can be found at next url: https://server.poissonboltzmann.org/.\n\n## \ud83d\ude80 Launching the software\n\n### \ud83c\udfa5 Example\n\nTo test the program, use the following commands in `\ud83d\udcc1 smiffer/`:\n\n```sh\n$ mkdir data/output/\n\n# Launching the software.\n$ smiffer -i data1EHE.pdb \\\n$ -p data1EHE_parameter.yml \\\n$ -a data/1EHE_APBS.dx \\\n$ -o data/output/\n\n# Visualize using VMD (or other like PyMol, Chimera, Mol*, etc.).\n$ vmd data/1EHE.pdb data/output/*.dx\n```\n\n### \ud83d\udd0d Parameters description\n\n| **Argument** | **Mandatory?** | **Type and usage** | **Description** |\n| :------------------------ | :------------: | :--------------------- | :--------------------------------------------------------------------------- |\n| **`-i` or `--input`** | Yes | `--input file.pdb` | The `.pdb` file that while be used<br/>to computed the properties. |\n| **`-o` or `--output`** | Yes | `--output directory` | The directory to output the results. |\n| **`-p` or `--parameter`** | No | `--parameter file.yml` | The YAML parameters file. |\n| **`-a` or `--apbs`** | No | `--apbs file.dx` | The already computed APBS<br/>electrostatic grid. |\n| **`-h` or `--help`** | No | Flag | Display the help and exit the<br/>program. |\n| **`-v` or `--version`** | No | Flag | Display the version and exit the<br/>program. |\n| **`--verbose`** | No | Flag | Activated a verbose mode, so more<br/>information are going to be displayed. |\n\n## \ud83d\ude47\u200d\u2642\ufe0f Aknowledgement\n\n\ud83d\udd0d Code reviewing: **Hubert Santuz**\n\n_This work is licensed under a [MIT License](https://opensource.org/licenses/MIT)._\n\n[](https://opensource.org/licenses/MIT)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Compute possible interaction with fields arround protein or RNA.",
"version": "0.0.3",
"project_urls": {
"Documentation": "https://smiffer.mol3d.tech",
"Homepage": "https://gitlab.galaxy.ibpc.fr/rouaud/smiffer",
"Repository": "https://gitlab.galaxy.ibpc.fr/rouaud/smiffer"
},
"split_keywords": [
"python",
" chemical",
" grid",
" rna",
" protein",
" properties",
" physical based computation",
" bioinformatic",
" chemoinformatic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1594df99a83be06bc20605ec2c70c0abd9b736013066c8b29f554e2aff93f024",
"md5": "adf1aaeb6d30a77430a76582e3eabc2e",
"sha256": "3c8a0c593db157c4239cace420a1a39474223df95660678781ddf08d15fcfa8c"
},
"downloads": -1,
"filename": "smiffer-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adf1aaeb6d30a77430a76582e3eabc2e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 4070,
"upload_time": "2024-09-02T15:12:28",
"upload_time_iso_8601": "2024-09-02T15:12:28.702868Z",
"url": "https://files.pythonhosted.org/packages/15/94/df99a83be06bc20605ec2c70c0abd9b736013066c8b29f554e2aff93f024/smiffer-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4b27337506678ff434726a01bbe09b5f3e06f2dc164139ad067f1d757b95c18",
"md5": "a6d81f9e7db77c33832d417475f8d700",
"sha256": "7d339c890b35ca446225dcf799a9bd5882ee64746442139a657d30e1ada8419f"
},
"downloads": -1,
"filename": "smiffer-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "a6d81f9e7db77c33832d417475f8d700",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 30571,
"upload_time": "2024-09-02T15:12:30",
"upload_time_iso_8601": "2024-09-02T15:12:30.265045Z",
"url": "https://files.pythonhosted.org/packages/a4/b2/7337506678ff434726a01bbe09b5f3e06f2dc164139ad067f1d757b95c18/smiffer-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 15:12:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "smiffer"
}
JSON