Merge pull request #196 from antarctica/0.2.x

0.2.x (mesh building) release!

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -1,22 +1,28 @@
 # PolarRoute Pull Request Template
 
 Date: <!--- Include date PR was created -->   
-Version Number: <!--- Include version number of PolarRoute the PR will be included in (e.g. 0.1.0) -->   
+Version Number: <!--- Include version number of PolarRoute the PR will be included in (e.g. 0.1.0 -> 0.1.1) -->   
 
 ## Description of change
 <!--- Describe your changes in detail -->
 
-Fixes # (issue)
+## Fixes # (issue)
 <!--- If this PR adds functionality or resolves problems associated with an issue on GitHub, please include a link to the issue -->
 
 # Testing
-To ensure that the functionality of the PolarRoute codebase remains consistent throughout the development cycle a testing strategy has been developed, which can be viewed in the document `.github/PULL_REQUEST_TEMPLATE/testing_strategy.md`. 
+To ensure that the functionality of the PolarRoute codebase remains consistent throughout the development cycle a testing strategy has been developed, which can be viewed in the document `test/testing_strategy.md`. 
 This includes a collection of test files which should be run according to which part of the codebase has been altered in a pull request. Please consult the testing strategy to determine which tests need to be run. 
 
+- [ ] My changes have not altered any of the files listed in the testing strategy
 
 - [ ] My changes result in all required regression tests passing without the need to update test files.  
+
+> *list which files have been altered and include a pytest.txt file for each of
+> the tests required to be run*
+>
+> The files which have been changed during this PR can be listed using the command
 
-> *include pytest.txt file showing all tests passing.*  
+    git diff --name-only 0.2.x
 
 - [ ] My changes require one or more test files to be updated for all regression tests to pass.   
 

.gitignore

@@ -17,6 +17,7 @@ TestingNotebook.ipynb
 *.output.*json
 setup.cfg
 pip.sh
+datastore
 ./datastore/*
 datastore/*
 configs/*

README.md

@@ -8,13 +8,14 @@
 <a href="https://github.com/antarctica/PolarRoute/blob/main/LICENSE"><img src="https://img.shields.io/github/license/antarctica/PolarRoute" alt="License"></a>
 
 # PolarRoute
-> PolarRoute is a long-distance maritime polar route planning, taking into account complex changing environmental conditions. The codebase allows the construction of optimised routes through three main stages: discrete modelling of the environmental conditions using a non-uniform mesh, the construction of mesh-optimal paths, and physics informed path smoothing. In order to account for different vehicle properties we construct a series of data driven functions that can be applied to the environmental mesh to determine the speed limitations and fuel requirements for a given vessel and mesh cell, representing these quantities graphically and geospatially.
+PolarRoute is a long-distance maritime polar route planning package, taking into account complex changing environmental conditions. The codebase allows the construction of optimised routes through three main stages: discrete modelling of the environmental conditions using a non-uniform mesh, the construction of mesh-optimal paths, and physics informed path smoothing. In order to account for different vehicle properties we construct a series of data driven functions that can be applied to the environmental mesh to determine the speed limitations and fuel requirements for a given vessel and mesh cell, representing these quantities graphically and geospatially.
 
 ## Installation
-The PolarRoute software requires GDAL files to be installed. The PolarRoute software can be installed on Windows by running the required wheels for GDAL and FIONA. MOre information can be found in the manual pages linked above. Once these requirements are met then the software can be installed by:
+The PolarRoute package requires GDAL files to be installed. This software can be installed on Windows by running the required wheels for GDAL and FIONA. More information can be found in the manual pages linked above. Once these requirements are met then the software can be installed by:
 
 Github:
 ```
+git clone https://github.com/Antarctica/PolarRoute
 python setup.py install
 ```
 
@@ -23,6 +24,8 @@ python setup.py install
 pip install polar-route
 ```
 
+> NOTE: The installation process may vary slightly dependent on OS. Please consult the documentation for further installation guidance.
+
 ## Required Data sources
 Polar-route has been built to work with a variety of open-source atmospheric and oceanographic data sources. 
 A list of supported data sources and their associated data-loaders is given in the 
@@ -45,7 +48,7 @@ rm -r docs/build/.doctrees/
 Jonathan Smith, Samuel Hall, George Coombs, James Byrne,  Michael Thorne, Maria Fox, Harrison Abbot, Ayat Fekry
 
 ## Collaboration
-We are currently assessing the best pratice for collaboration on the codebase, until then please contact [marfox@bas.ac.uk]([email protected]) or [[email protected]](jonsmi@bas.ac.uk) for further info.
+We are currently assessing the best practice for collaboration on the codebase, until then please contact [polarroute@bas.ac.uk](polarroute@bas.ac.uk) for further info.
 
 
 ## License

docs/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f5c21da8605eb8472f39c71741ffa923
+config: ff9ebad1c8db7cc3ee17404f270eae40
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/_sources/index.rst.txt

@@ -1,19 +1,34 @@
-Welcome RoutePlanner Manual Pages
-=====================================
+Welcome to the PolarRoute Manual Pages
+======================================
+
+PolarRoute is a tool for the optimisation of routes for maritime vehicles travelling in polar waters.
+This software package has been developed by the **British Antarctic Survey** (BAS), primarily 
+for the optimisation of polar routes for the BAS research vessel RRS Sir David Attenborough, 
+though it is applicable to any vessel (e.g. AUVs). The software is written in Python and is open source.
+
+For more information on the project, please visit the `PolarRoute website <https://www.bas.ac.uk/project/autonomous-marine-operations-planning/>`_
+and follow our `GitHub repository <https://github.com/antarctica/PolarRoute>`_.
+
+
+.. note:: The development of this codebase is ongoing and not yet complete. 
+          Please contact the developers for more information.
 
 Contents:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :numbered:
 
-   ./sections/Code_structure
+   ./sections/Code_overview
    ./sections/Installation
-   ./sections/running
-   ./sections/Configuration
-   ./sections/Dataloaders/overview
+   ./sections/ipython_notebooks
+   ./sections/Command_line_interface
+   ./sections/Configuration/Configuration_overview
    ./sections/Outputs
-   ./sections/Examples
-   ./sections/Discrete_meshing
+   ./sections/Dataloaders/overview
+   ./sections/Mesh_Construction/Mesh_construction_overview
    ./sections/Vehicle_specifics
+   ./sections/Route_calculation
    ./sections/Route_optimisation
+   ./sections/Examples
+