Merge pull request #426 from ISISNeutronMuon/package-description-corr…

…ections Correct the package tags for PyPI and installation instructions
ISISNeutronMuon · Apr 29, 2024 · c67c54c · c67c54c
2 parents 7f6727f + 64c3c8d
commit c67c54c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/MDANSE/pyproject.toml b/MDANSE/pyproject.toml
@@ -20,7 +20,8 @@ classifiers = [
         'Development Status :: 3 - Alpha',
 
         'Intended Audience :: Science/Research',
-        'Topic :: Software Development :: Build Tools',
+        'Topic :: Scientific/Engineering :: Chemistry',
+        'Topic :: Scientific/Engineering :: Physics',
 
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3 :: Only',

diff --git a/MDANSE_GUI/pyproject.toml b/MDANSE_GUI/pyproject.toml
@@ -20,7 +20,9 @@ classifiers = [
         'Development Status :: 3 - Alpha',
 
         'Intended Audience :: Science/Research',
-        'Topic :: Software Development :: Build Tools',
+        'Topic :: Scientific/Engineering :: Chemistry',
+        'Topic :: Scientific/Engineering :: Physics',
+        'Topic :: Scientific/Engineering :: Visualization',
 
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.9',
@@ -34,6 +36,7 @@ dependencies = [
     "qtpy",
     "vtk",
     "PyQt6",
+    "pyqt6-tools",
     "PyYAML",
 ]
 

diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ source mdanse_env/bin/activate
 ```
 in a bash console, or
 ```
-mdanse_end/Scripts/activate.bat
+mdanse_end\Scripts\activate.bat
 ```
 if you are using cmd.exe on Windows.
 
@@ -44,6 +44,18 @@ and start the graphical interface by typing
 mdanse_gui
 ```
 
+## Installation: development version
+
+At the moment MDANSE and MDANSE_GUI are undergoing frequent changes. If you would
+like to try out the latest development version, you can install directly from GitHub
+using pip:
+```
+python3 -m pip install "git+https://github.com/ISISNeutronMuon/MDANSE@protos#egg=MDANSE&subdirectory=MDANSE"
+python3 -m pip install "git+https://github.com/ISISNeutronMuon/MDANSE@protos#egg=MDANSE_GUI&subdirectory=MDANSE_GUI"
+```
+
+## Quick start: the workflow
+
 The typical workflow of MDANSE:
 
 1. Convert a trajectory from the file format generated by an MD simulation software into the MDANSE trajectory format,