Skip to main content

Python Fermi-orbital descriptor Monte-Carlo (PyfodMC)

Project description

PyfodMC - Python Fermi-orbital descriptor Monte-Carlo

license language version

The Python Fermi-orbital descriptor Monte-Carlo (PyfodMC) is a Python code for
the determination of Fermi-orbital descriptors (FODs) for atomic, molecular,
and periodic systems. It follows a simple input structure, where users primarily
define the bond patterns between the atoms in the structure. Everything else
is handled internally through PyfodMC. Additional options for greater flexibility
have also been added, like the explicit definition of lone FODs. Further options
include the definiton of charge, whether to exchange the up and the dn channel,
the definition of alternate electronic configurations, and the removal of core FODs
for each atom.

PyfodMC is the successor of the Fermi-orbital descriptor Monte-Carlo (fodMC) code.
PyfodMC is based on fodMC, version 1.2.2, but has been written exclusively in Python.
Furthermore, several improvements over the original fodMC code have been added for
increased robustness and reproducibility.
As such, the support for the original fodMC code will stop, and support for the PyfodMC
code will start.

Installation

Using pip

$ pip3 install PyfodMC

or install locally

$ git clone https://gitlab.com/opensic/PyfodMC.git
$ cd PyfodMC
$ pip3 install -e .

Examples can be found in the examples folder.

Citation

For publications, please consider citing the following articles

ATTENTION

While the PyfodMC can create FODs for
any system, we do not recommend using
guesses for systems containing transition metals.

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

pyfodmc-1.1.5.tar.gz (44.6 kB view details)

Uploaded Source

Built Distribution

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

pyfodmc-1.1.5-py3-none-any.whl (46.8 kB view details)

Uploaded Python 3

File details

Details for the file pyfodmc-1.1.5.tar.gz.

File metadata

  • Download URL: pyfodmc-1.1.5.tar.gz
  • Upload date:
  • Size: 44.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for pyfodmc-1.1.5.tar.gz
Algorithm Hash digest
SHA256 14caf2fe7408c0e9e2b0ab917f40207797d8529b880535db85459eadacf2349c
MD5 dc95766e1fc7123ce1ed9121e8d39723
BLAKE2b-256 31b730de9de5ed8dd58f3583ec6a7ebd0b8d4d7e595327c9968a211194cf1f8e

See more details on using hashes here.

File details

Details for the file pyfodmc-1.1.5-py3-none-any.whl.

File metadata

  • Download URL: pyfodmc-1.1.5-py3-none-any.whl
  • Upload date:
  • Size: 46.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for pyfodmc-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7b31a4124db2f403f0b1e054cfe7fd62f2b9c5a441ac6eb170cad0fc54285c9b
MD5 1da1d3d0a8e60b669220ab9899bb0366
BLAKE2b-256 ae2f60b7f2b3829076faf856547f60403b04e8fe2aa9a9e122bbda18a378fc0f

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