Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Welcome to the udkm1Dsim toolbox

Documentation Status CI pypi codecov CodSpeed Badge Conda Version PyPI PyPI downloads

The udkm1Dsim toolbox is a collection of Python classes and routines for simulating the thermal, structural, and magnetic dynamics of one-dimensional sample structures following ultrafast laser excitation. It also enables the calculation of the corresponding light and X-ray scattering response, providing a unified framework for modeling coupled ultrafast dynamics and their experimental observables.

The udkm1Dsim toolbox provides a comprehensive framework for defining arbitrary layered structures at the atomic level, supported by a rich database of element-specific physical properties. Ultrafast excitation is described using an N-temperature model, a widely used approach for simulating energy transfer following ultrafast optical excitation. Structural dynamics driven by thermally induced stresses are calculated using a linear-chain model of coupled masses and springs, while magnetization dynamics can be simulated with Landau–Lifshitz-type models. The resulting optical and X-ray scattering response is computed using kinematical or dynamical scattering theory, including resonant magnetic X-ray scattering, enabling direct comparison between time-resolved simulations and a wide range of ultrafast scattering experiments.

The simulation framework is highly modular. Each module returns standard numpy arrays that can be inspected, modified, or used directly as input for subsequent simulations, allowing users to build customized workflows with ease.

The current toolbox, written in Python, is maintained by Daniel Schick at the Max Born Institut, Berlin, Germany.

Documentation

The documentation can be found at udkm1Dsim.readthedocs.io.

Citation

Please cite the latest publication if you use the toolbox in your own work:

You can also cite the original publication if appropriate:

Installation

Installing with pip

You can either install directly from pypi.org using the command

pip install udkm1Dsim

or if you want to work on the latest develop release you can clone udkm1Dsim from the main git repository:

git clone https://github.com/dschick/udkm1Dsim.git udkm1Dsim

To work in editable mode (source is only linked but not copied to the python site-packages), just do:

pip install -e ./udkm1Dsim

Or to do a normal install with

pip install ./udkm1Dsim

Optionally, you can also let pip install directly from the repository:

pip install git+https://github.com/dschick/udkm1Dsim.git

You can have the following optional installation to enable parallel computations as well as building the documentation:

pip install "udkm1Dsim[parallel]"
pip install "udkm1Dsim[docs]"

The dependencies of the unit tests are installed from the cloned repository with pip 25.1 or newer:

pip install ./udkm1Dsim --group ./udkm1Dsim/pyproject.toml:test

Installing with conda

You can install directly from conda-forge using conda:

conda install -c conda-forge udkm1dsim

or using mamba:

mamba install udkm1dsim

See udkm1dsim-feedstock for more details

Contribute & Support

If you are having issues please let us know via the issue tracker.

You can also ask questions, share ideas, or engage with community members via the discussions.

You can contribute to the project via pull-requests following the GitHub flow concept.

Contributers

Thanks to all who have contributed to the udkm1Dsim toolbox!

License

The project is licensed under the MIT license.

Metadata

Release files for udkm1Dsim 3.0.0a2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for udkm1Dsim 3.0.0a2
File Size Uploaded Provenance Actions
udkm1dsim-3.0.0a2.tar.gz 15.9 MB Without provenance Details for udkm1dsim-3.0.0a2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for udkm1Dsim 3.0.0a2
File Interpreter ABI Platform Actions
udkm1dsim-3.0.0a2-py3-none-any.whl Python 3 none any Details for udkm1dsim-3.0.0a2-py3-none-any.whl

Total release size: 19.7 MB

Release files / udkm1dsim-3.0.0a2.tar.gz

Download URL udkm1dsim-3.0.0a2.tar.gz
Size 15.9 MB
Tags Source
SHA-256 checksum
How to use checksums
f37e6e4793607bc2aec5faf2596ce3231fea62c39e1bc028fc6c981391be2361
BLAKE2b-256 checksum
How to use checksums
4a1700bc4d7ead27f69638941f56435856a7658ee309995e98405d4a5b541887
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / udkm1dsim-3.0.0a2-py3-none-any.whl

Download URL udkm1dsim-3.0.0a2-py3-none-any.whl
Size 3.9 MB
Tags Python 3
SHA-256 checksum
How to use checksums
fc53be2963292bb0bafba1a70747e76893ae2cd09a4cb8c668fd679783685805
BLAKE2b-256 checksum
How to use checksums
6841ebda3ed3357d9dc386006b2617bb73fd788be102f88ff0c5a1906ae7a79f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for udkm1Dsim 3.0.0a2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page