Skip to main content

Python package for deep learning on molecular point clouds.

Project description

AIdsorb logo

Static Badge Static Badge GitHub Actions Workflow Status GitHub Actions Workflow Status GitHub Actions Workflow Status

Static Badge Static Badge

AIdsorb is a Python package for deep learning on molecular point clouds.

This package aims to provide a simple, easy-to-use and reproduce interface for:

  • 📥 Creating molecular point clouds

  • 🤖 Training DL algorithms on molecular point clouds

IRMOF-1 Cu-BTC UiO-66

⚙️ Installation

[!IMPORTANT] It is strongly recommended to perform the installation inside a virtual environment.

Assuming an activated virtual environment:

pip install aidsorb

🚀 Usage

[!NOTE] Refer to the 📚 Documentation for more information.

Here is a summary of what you can do from the command line:

  1. Visualize a molecular point cloud:

    aidsorb visualize path/to/structure
    
  2. Create and prepare point clouds:

    aidsorb create path/to/inp path/to/out  # Create point clouds
    aidsorb prepare path/to/out  # Split point clouds to train, val and test
    

    where path/to/inp is a directory containing molecular structures.

  3. Train and test a model:

    aidsorb-lit fit --config=path/to/config.yaml
    aidsorb-lit test --config=path/to/config.yaml --ckpt_path=path/to/ckpt
    

💡 Contributing

🙌 We welcome contributions from the community to help improve and expand this project!

You can start by 🛠️ opening an issue for:

  • 🐛 Reporting bugs
  • 🌟 Suggesting new features
  • 📚 Improving documentation
  • 🎨 Adding your example to the Gallery

We appreciate your efforts to submit well-documented 🔃 pull requests and participate in discussions.

💪 Together, we can make this project even better!

📑 Citing

If you use AIdsorb in your research, please consider citing the following work:

Currently, not available.

⚖️ License

AIdosrb is released under the GNU General Public License v3.0 only.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aidsorb-1.0.0.tar.gz (10.4 MB view details)

Uploaded Source

Built Distribution

aidsorb-1.0.0-py3-none-any.whl (79.5 kB view details)

Uploaded Python 3

File details

Details for the file aidsorb-1.0.0.tar.gz.

File metadata

  • Download URL: aidsorb-1.0.0.tar.gz
  • Upload date:
  • Size: 10.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for aidsorb-1.0.0.tar.gz
Algorithm Hash digest
SHA256 da5b869971a2d0f87d5eb72b5701f2f4f359fa982697ba33146f9b2f2b5210b8
MD5 8e50141bd8eb3800c4ce53f2a32b3414
BLAKE2b-256 8ba664920f66ec894287d1b0318e87db5e474301a749d00b2e57e2400fc633ca

See more details on using hashes here.

File details

Details for the file aidsorb-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: aidsorb-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 79.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for aidsorb-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ea174f12512c15e88a1e0ee3286b06fb5b3ecffe15ba0725f7bcbd5012718c81
MD5 353db23bd30a7aa2601e0bc3092eba36
BLAKE2b-256 1d8d07653fe556abced23ffbf21254da61b5ebf08b645d3689b2d67c59ed686b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page