params.json

{
  "name": "udkm1Dsim",
  "tagline": "A Simulation Toolkit for 1D Ultrafast Dynamics in Condensed Matter",
  "body": "# Introduction\r\n\r\nThe udkm1Dsim toolbox is a collection of classes and routines \r\nto simulate the structural dynamics and the according X-ray \r\ndiffraction response in one-dimensional sample structures after \r\nultrafast excitation. \r\nThe toolbox provides the capabilities to define arbitrary layered \r\nstructures on the atomic level including a rich database of \r\nelement-specific physical properties. \r\nThe excitation of ultrafast dynamics is represented by an \r\nN-temperature-model which is commonly applied for ultrafast \r\noptical excitations. \r\nStructural dynamics due to thermal stresses are calculated by \r\na linear-chain model of masses and springs. \r\nThe resulting X-ray diffraction response is computed by dynamical \r\nX-ray theory. \r\nThe udkm1Dsim toolbox is highly modular and allows to introduce \r\nuser-defined results at any step in the simulation procedure.\r\n\r\nThe udkm1Dsim toolbox was developed in the Ultrafast Dynamics \r\nin Condensed Matter group of Prof. Matias Bargheer at the \r\nUniversity of Potsdam, Germany. \r\nThe toolbox is currently maintained by Daniel Schick.\r\n\r\n# Citation\r\n\r\nPlease cite the following article if you use the udkm1Dsim toolbox for your own publications:\r\n\r\nD. Schick, A. Bojahr, M. Herzog, R. Shayduk, C. von Korff Schmising & M. Bargheer,\r\nudkm1Dsim - A Simulation Toolkit for 1D Ultrafast Dynamics in Condensed Matter,\r\n[Comput. Phys. Commun. 185, 651 (2014)](http://doi.org/10.1016/j.cpc.2013.10.009) \r\n[(preprint)](http://www.udkm.physik.uni-potsdam.de/medien/udkm1Dsim/udkm1DsimManuscriptPrePrint.pdf).\r\n\r\n# Compatibility\r\n\r\nThe udkm1Dsim toolbox was tested on MATLAB 2010a (7.10) - 2016a (9.0)\r\n\r\n# Installation\r\n\r\nAdd the udkm1Dsim toolbox folder and all of its \r\nsubfolder to your MATLAB searchpath by excecuting \r\nthe command:\r\n\r\n```\r\n   addpath(genpath('path2udkm1Dsim'));\r\n```\r\n   \r\nIn order to use the udkm1Dsim documentation\r\nbefore MATLAB 2013a (8.1) \r\n- open the MATLAB Preferences from the File menu. \r\n- click Help, and then select the All Products button.\r\n\r\nsince MATLAB 2013a (8.1)\r\n- open the MATLAB Help and click on \"Supplemental Software\" on the lower \r\n  left of the help start page\r\n\r\nOpen the MATLAB Product Help and open the udkm1Dsim\r\ntoolbox documentation from the content listing.\r\nFollow the Getting Started to get familar with the \r\nsimulation workflow.\r\n\r\nIn order to run the example files change your current \r\nMATLAB directory to `path2udkm1Dsim/examples/`.",
  "note": "Don't delete this file! It's used internally to help with page regeneration."
}