Skip to content

Analyze and run your tristan-MP simulations with less boilerplate code. tristanUtils consists of two main utilities: automater.py a python script that will submit tristan scripts using the slurm workload manager & a python 3 class TristanSim which exposes the data saved by tristan-MP.

License

Notifications You must be signed in to change notification settings

pcrumley/tristanUtils

Repository files navigation

Analyze and run your tristan-MP simulations without boiler-plate. tristanUtils consists of three main utilities: automater.py a python script that will submit tristan scripts using the slurm workload manager, a python 3 class TristanSim which exposes the data saved by tristan-MP, and set of helper function in helperFuncs.py

All documentation of these utilities is at this project's Github-Page

Automater.py

Make it easy to submit many many small tristan-MP jobs. Documentation here

Will not work for 3D runs (will work for 2D runs, 1D runs not tested but should work.)

Currently assume every job has roughly the same computational cost when doing load balancing accross slurm scripts. May want to consider a mode where more cells or particles means that more cores are dedicated to the run.

TristanSim class

An Object Relational Mapping (ORM) that makes it easy to lazily load all your tristan data as attributes of an object. e.g., any value in the ith output step can be accessed as sim[i].ex for example. Documentation here

Consider switching the trackedLecs/trackedIons objects into a pandas dataframe

Needs to build faster (takes 10 seconds to open a sim that is like 100 outputfiles.) => This is fixed now!

helperFuncs

Easy way to make matplotlib plots. I have phase diagrams, 2D averages, and 1D hist and 1d averages implemented. Documentation here. Note: documentation is incomplete.

About

Analyze and run your tristan-MP simulations with less boilerplate code. tristanUtils consists of two main utilities: automater.py a python script that will submit tristan scripts using the slurm workload manager & a python 3 class TristanSim which exposes the data saved by tristan-MP.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages