Skip to main content

A command line program to predict NICS-XY scan results based on an additivity scheme.

Project description

Predi-XY

version 1.2.0

A command line program to predict NICS-XY scan results based on an additivity scheme.

Requires Python 3.7 or newer. To check which version of Python is active:

python --version

Installation

Recommended installation method:

Predixy is available on PyPI, so simply install it using pip:

pip install predixy

Manual installation:

Navigate to the top level folder of the downloaded/cloned repository. Then you can either run the setup.py script or manually install requirements using pip.

Installation using setup.py:

python setup.py install

Install dependencies using pip:

pip install -r requirements.txt

Running the program

If you installed the program from PyPI or using the setup.py, you will have predixy in your PATH and can run it from anywhere. Just run:

predixy INFILE

If you only installed the dependencies, you can need to navigate to the top level folder containing predixy.py and run:

python predixy.py INFILE

The INFILE should be a .xyz or Gaussian .in file containing the xyz coordinates in Angstrom of the molecule you would like to analyze.

Help

To get the help and list all options, run (depending on your installation method):

predixy --help

or:

python predixy.py --help

Editing the configuration file

Edit the config.ini file using your favorite editor. Lines starting with # and ; are comments. Do not delete lines as this will cause errors. The location of the config file can be retrieved from the program by using the help.

What's new in version 1.2.0

Papers to cite were updated. Scan distance was fixed (now starts at 0). Data for building blocks was corrected. Reading in xyz files was fixed.

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

predixy-1.2.0.tar.gz (33.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

predixy-1.2.0-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file predixy-1.2.0.tar.gz.

File metadata

  • Download URL: predixy-1.2.0.tar.gz
  • Upload date:
  • Size: 33.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.7

File hashes

Hashes for predixy-1.2.0.tar.gz
Algorithm Hash digest
SHA256 047a93a00d20ba4925dc28e82ec00e2c18f1e17a51ca988f6ecec1067a915c53
MD5 aa4f49a14486d1cf946c5a5879ab791b
BLAKE2b-256 2f9c6832fd72c063e029c072874ca97b0a803c5638abac16554580188a51fa30

See more details on using hashes here.

File details

Details for the file predixy-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: predixy-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 48.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.7

File hashes

Hashes for predixy-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 faa4b33398cfe43faa6f1c3a27136dad323cc8982dce76fc86238505439c2f5d
MD5 158c81288d4ab99d72fd39823ed9bdb6
BLAKE2b-256 84965d6b33f2a91aa0a76af16a69de03990a337a5b6ac6e828772f05a9951d33

See more details on using hashes here.

Supported by

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