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.3.tar.gz (43.7 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.3-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfodmc-1.1.3.tar.gz
  • Upload date:
  • Size: 43.7 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.3.tar.gz
Algorithm Hash digest
SHA256 c16afa7c9b5a6759be64b198f90e7c93bf539ac69abd8cbcae89c1cd259e45a8
MD5 5f66ee847eb981a2c5628785002338b7
BLAKE2b-256 729f2b3f7e3c4984679f30c7f286dde18533646d44ec4c3be8b4920a4f167a89

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyfodmc-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 46.0 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ef488253e8a356f9270bbc609185965513cf52ff3d8962999529a581b8002d93
MD5 df51facca06c255ca7f7a655c2600fd2
BLAKE2b-256 2dfd7c2e0422ccbed8f4b56c5c2c3a5364cd0172f387c8422895fdc72446bc9d

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