Skip to main content

Estimates atom counts in monometallic nanoparticles given radius and contact angle

Project description

Treating a supported nanoparticle as a spherical cap, NanoparticleAtomCounter rapidly estimates the number of Total, Surface, Perimeter, and Interfacial atoms (see below). Only two inputs are needed: the radius and contact angle, readily obtainable from Transmission Electron Microscopy (TEM) images.

Atom types discriminated

Can be used on the web app or on a command line.

Requirements

  • numpy>=1.20,<2.3

  • pandas>=1.4

  • streamlit>=1.4,<2

  • openpyxl>=3.1.0

  • xlrd>=2.0.1

For testing, these are also required

  • pytest>=8,<9

  • ase>=3.22.0,<3.25

  • tqdm<=4.67.1

  • joblib<=1.5.1

  • ascii-colors

Installation

First create and activate a new environment:

mamba create --name env_name "python>=3.10,<3.15"
mamba activate env_name

To install the latest version:

pip install NanoparticleAtomCounter

Alternatively:

git clone git@github.com:giolajide/nanoparticleatomcounter.git
cd nanoparticleatomcounter
pip install -e .

To also be able to run tests, install as:

pip install NanoparticleAtomCounter[test]

Usage

  • To use on the web app, upload your input file and download the output

  • To use on a command line:

    nanoparticle-atom-counter --input input.csv --output output.csv

Testing

If you have it installed with the tests, then please run the following test and let me know if there are any errors:

atom-count-test

Contact

Any problems or questions?

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

nanoparticleatomcounter-0.1.0.tar.gz (50.0 kB view details)

Uploaded Source

Built Distribution

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

nanoparticleatomcounter-0.1.0-py3-none-any.whl (58.0 kB view details)

Uploaded Python 3

File details

Details for the file nanoparticleatomcounter-0.1.0.tar.gz.

File metadata

  • Download URL: nanoparticleatomcounter-0.1.0.tar.gz
  • Upload date:
  • Size: 50.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.18

File hashes

Hashes for nanoparticleatomcounter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 470f83dd146a93e840001ae40ce290d73e7d6e0d014f68f8657bae64c3beb815
MD5 3c7ececd1fbed5993272c28cc3592eb1
BLAKE2b-256 5490c503580eb1ad8164dc905dae71290ee7ed21a3eb4ceb849ebf7fcde62430

See more details on using hashes here.

File details

Details for the file nanoparticleatomcounter-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nanoparticleatomcounter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83a569ded14de4897b46ce3324081971e3972c4b6402878158948305098c45af
MD5 fde7c2f385eef664ddc8ecfe88dec268
BLAKE2b-256 8e1550a5d629f942beac795b976d187d61dd93a55ebd9f7da89bda95567fcf52

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