Skip to main content

A Python package to perform pre- and post-processing of molecular simulations

Project description

Welcome to Use Xponge!

What is Xponge?

Xponge is a lightweight and easy-customizing python package to perform pre- and post-processing of molecular simulations.

What can Xponge do?

Xponge includes three major categories of functionality, namely, the simulation system construction, simulation data transformation and analysis, and automated workflows for complex simulations. Xponge is mainly designed for the molecular dynamics (MD) program SPONGE, but it can also output some general format files such as mol2 and PDB, so it may help the other molecular modelling programs too.

How can I get Xponge?

Xponge can be used on both Windows and Linux operating systems

1. pip install

pip install Xponge

2. source setup

  • 2.1 download or clone the source of the gitee or github repository

    The gitee repository is here. The github repository is here.

  • 2.2 open the directory where you download or clone the repository

  • 2.3 run the command

    python setup.py install
    

How can I check whether I have installed Xponge correctly?

There are some unit tests in Xponge. You can do the basic test to check whether the installation is successful like this:

Xponge test -do base -o test

Here, Xponge can be replaced to python -m Xponge, python3 -m Xponge and so on according to your settings of the environmental variables.

Can you give me a example to use?

Here is a simple example.

import Xponge
# import the force field you need
import Xponge.forcefield.amber.ff14sb
# build the molecule
peptide = ACE + ALA + NME
# save it as your favorite format
Xponge.save_pdb(peptide, "ala.pdb")
Xponge.save_mol2(peptide, "ala.mol2")
Xponge.save_sponge_input(peptide, "ala")

Where can I see the complicated usage, the API documentation or the way to develop my own force field?

All can be seen here.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

Xponge-1.2.6.2.tar.gz (500.2 kB view details)

Uploaded Source

File details

Details for the file Xponge-1.2.6.2.tar.gz.

File metadata

  • Download URL: Xponge-1.2.6.2.tar.gz
  • Upload date:
  • Size: 500.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for Xponge-1.2.6.2.tar.gz
Algorithm Hash digest
SHA256 f50090285b2b208269072b7a2cdf48c02257f961acf88d091776bef713e22a1b
MD5 c1ee42cb8cf466ed1332c213087a25d2
BLAKE2b-256 538e9573f57d9125fa5cbe13d196ecf39d13d9674217dea52975e93757d2dcaf

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