MDANSE GUI package - the graphical interface for MDANSE
Project description
MDANSE_GUI
MDANSE_GUI Python Module
This is the module containing the Graphical User Interface (GUI) of the Molecular Dynamics Analysis for Neutron Scattering Experiments (MDANSE) software package.
The GUI depends on the MDANSE package.
Version information
This is the alpha release of MDANSE_GUI 0.1.0. The GUI has been re-written completely using Qt. Please help us develop MDANSE_GUI by reporting any problems you experience when using the code. The preferred way of reporting problems is by adding them to the GitHub issue tracker.
Quick start: installation
We recommend that you install MDANSE in a Python virtual environment. You can create a virtual environment named mdanse_env by typing
python3 -m venv mdanse_env
To activate your virtual environment, type
source mdanse_env/bin/activate
in a bash console, or
mdanse_end/Scripts/activate.bat
if you are using cmd.exe on Windows.
While your virtual environment is active, you can install MDANSE:
pip install MDANSE_GUI
and start the GUI by typing
mdanse_gui
If you experience problems with the installation, you may want to upgrade pip
pip install --upgrade pip
and try again.
Quick start: workflow
The typical workflow of MDANSE:
- Convert a trajectory from the file format generated by an MD simulation software into the MDANSE trajectory format,
- Load the converted trajectory into MDANSE,
- Perform an analysis,
- Check the results with the plotter.
Each one of these operations (apart from the plotter) has its own dedicated tab in the GUI. The plotter can be started using a button on the top toolbar.
The most complete user documentation of MDANSE can be found on our Read the Docs page.
Other information including example scripts can be found on the MDANSE website
Citing MDANSE
If you used MDANSE in your research, please cite the following paper:
MDANSE: An Interactive Analysis Environment for Molecular Dynamics Simulations. G. Goret, B. Aoun, E. Pellegrini. J Chem Inf Model. (2017) 57(1):1-5.
License
MDANSE_GUI is licensed under GPL-3.0. See LICENSE for more information.
Acknowledgements
The VTK-based 3D viewer and the matplotlib-based data plotter were both taken and adapted from other software projects authored by Eric Pellegrini. We would like to thank Eric for making his code available.
Joining the project
MDANSE_GUI is currently maintained and developed by software developers from ISIS and ILL, but we are fully open to new collaborators who would like to contribute code, documentation, tutorials or usage examples. If you want to join the project contact:
Dr. Sanghamitra Mukhopadhyay (sanghamitra.mukhopadhyay@stfc.ac.uk)
ISIS Neutron and Muon Source
Rutherford Appleton Laboratory
Didcot, UK
Software Inquiries
For questions or contributions related to the software, please contact:
Dr. Maciej Bartkowiak (maciej.bartkowiak@stfc.ac.uk)
ISIS Neutron and Muon Source
Rutherford Appleton Laboratory
Didcot, UK
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for MDANSE_GUI-0.1.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf5308882abaa0ea2fefaa05a1b74e3999c387265f206c8dbb1d56fce650cf9b |
|
MD5 | 3d9a7231064e3802f8e7df0d2767e55c |
|
BLAKE2b-256 | 9f0084c22c6da2e9bbc986fdbe59fb186b29d27475428ff1c3bcb6fdcf7097c2 |