Updated README and website

- Updated README: added Python version, updated SSRN links, added information on contributions. - Updated index.rst: updated SSRN link, added information on contributing. - Updated api.rst: changed order inputoutputfunctions so the list is ordered alphabetically. - Updated quickstart.rst: clarified information on the Spyder IDE.
NanneD · Jul 25, 2024 · 18e1958 · 18e1958
1 parent ce60832
commit 18e1958
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@
 
 ELASPY (Electric Ambulance Simulator Python) is a discrete-event simulator of the emergency response process of electric and diesel ambulances built in Python. For more information, please visit the ELASPY website: https://nanned.github.io/ELASPY.
 
+The code is written in Python 3.10.8.
+
 ## Installation
 
 For installation instructions, please see: https://nanned.github.io/ELASPY/installation/installation.html.
@@ -18,7 +20,7 @@ For the user guide, including documentation and a quickstart, please see: https:
 If you would like to cite ``ELASPY``, please consider citing the following paper:
 > Nanne A. Dieleman, Caroline J. Jagtenberg (2024).
 > Electric ambulances: will the need for charging affect response times?
-> Available at SSRN: https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4874479.
+> Preprint available at SSRN: https://ssrn.com/abstract=4874479. doi: 10.2139/ssrn.4874479.
 
 Or, using the following BibTeX entry:
 
@@ -27,8 +29,9 @@ Or, using the following BibTeX entry:
 	title = {Electric ambulances: will the need for charging affect response times?},
 	author = {Dieleman, Nanne A. and Jagtenberg, Caroline J.},
 	year = {2024},
-        url = {https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4874479},
-} 
+        url = {https://ssrn.com/abstract=4874479},
+	doi = {10.2139/ssrn.4874479},
+}
 ```
 
 ## License
@@ -37,4 +40,19 @@ The GNU General Public License v3 (GPL-3) license is used. For more information,
 
 ## Contributing
 
-If you would like to contribute to the package in any way, please feel free to create an issue and discuss what you would like to add or change.
+If you would like to contribute to ``ELASPY`` in any way, please feel free to create an [issue](https://github.com/NanneD/ELASPY/issues) to discuss what you would like to add or change. Moreover, make sure that your code submission includes:
+- tests
+- type hints
+- documentation
+- docstrings for the added/changed methods, classes, etc. according to the NumPy docstrings format
+
+To check whether the type hints and tests run smoothly, you can follow these steps:
+1. Open the command line and move to the ``ELASPY`` folder.
+2. Run the tests by using the following command:
+```
+pytest elaspy/tests.py
+```
+3. Run the mypy checker by using:
+```
+mypy elaspy/
+```
diff --git a/doc/api/api.rst b/doc/api/api.rst
@@ -12,10 +12,10 @@ The API reference of all scripts, methods and classes can be found here.
     ambulance
     ambulancesimulation
     coordinatemethods
+    inputoutputfunctions
     main
     patient
     plotfunctions
-    inputoutputfunctions
 
 .. toctree::
     :maxdepth: 1

diff --git a/doc/index.rst b/doc/index.rst
@@ -8,7 +8,7 @@ ELASPY
 
 ELASPY (Electric Ambulance Simulator Python) is a discrete-event simulator of the emergency response process of electric and diesel ambulances. It is built with Python.
 
-With this simulator, you can analyze the impact of transferring from diesel to electric vehicles. The simulator is developed for urgent patient transport. During a simulation run, patients arrive to which ambulances respond by driving to the patient's site and providing on-site treatment. Afterwards, the patient may or may not have to be brought to the hospital by the ambulance, after which the ambulance returns to its base. For more details on the simulation process, please see the paper by `Dieleman and Jagtenberg <https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4874479>`_.
+With this simulator, you can analyze the impact of transferring from diesel to electric vehicles. The simulator is developed for urgent patient transport. During a simulation run, patients arrive to which ambulances respond by driving to the patient's site and providing on-site treatment. Afterwards, the patient may or may not have to be brought to the hospital by the ambulance, after which the ambulance returns to its base. For more details on the simulation process, please see the paper by `Dieleman and Jagtenberg <https://ssrn.com/abstract=4874479>`_.
 
 | **Citing**
 | Please see the README file on the `GitHub repository <https://github.com/NanneD/ELASPY>`_ for a suggested citation.
@@ -17,6 +17,9 @@ With this simulator, you can analyze the impact of transferring from diesel to e
 
 The GNU General Public License v3 (GPL-3) license is used. For more information, please see the `GitHub repository <https://github.com/NanneD/ELASPY>`_.
 
+| **Contributing**
+| Please see the README file on the `GitHub repository <https://github.com/NanneD/ELASPY>`_ for information on how to contribute.
+
 .. grid:: 1 2 2 4
 
     .. grid-item-card::

diff --git a/doc/user_guide/quickstart.rst b/doc/user_guide/quickstart.rst
@@ -9,7 +9,8 @@ The simulator works through the main interface found in ``elaspy/main.py``. All
 
 IDE Spyder
 ++++++++++
-The IDE Spyder is automatically installed if you installed ELASPY by following the :ref:`installation instructions<installation>`. First, activate the ELASPY environment by using the following command in the command line:
+
+The IDE Spyder is automatically installed if you installed the ``ELASPY`` environment by using the ``environment.yml`` file (see :ref:`installation instructions<installation>`). First, activate the ``ELASPY`` environment by using the following command in the command line (assuming you use `Anaconda <https://anaconda.org>`_ or `Miniconda <https://docs.anaconda.com/miniconda/>`_):
 
 .. code-block:: shell