-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #196 from antarctica/0.2.x
0.2.x (mesh building) release!
- Loading branch information
Showing
237 changed files
with
180,923 additions
and
415,278 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,6 +17,7 @@ TestingNotebook.ipynb | |
*.output.*json | ||
setup.cfg | ||
pip.sh | ||
datastore | ||
./datastore/* | ||
datastore/* | ||
configs/* | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
+28 Bytes
(100%)
docs/html/.doctrees/sections/Dataloaders/DataLoaderInterface.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
+2.47 KB
(100%)
docs/html/.doctrees/sections/Dataloaders/scalar/abstractScalar.doctree
Binary file not shown.
Binary file modified
BIN
+83 Bytes
(100%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/AMSR.doctree
Binary file not shown.
Binary file modified
BIN
-3.94 KB
(75%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/BSOSEDepth.doctree
Binary file not shown.
Binary file modified
BIN
-3.94 KB
(76%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/BSOSESeaIce.doctree
Binary file not shown.
Binary file modified
BIN
-3.9 KB
(74%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/BalticSeaIce.doctree
Binary file not shown.
Binary file modified
BIN
-2 Bytes
(100%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/BinaryGRF.doctree
Binary file not shown.
Binary file modified
BIN
-4.11 KB
(71%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/Density.doctree
Binary file not shown.
Binary file modified
BIN
-3.83 KB
(72%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/GEBCO.doctree
Binary file not shown.
Binary file modified
BIN
-3.83 KB
(75%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/IceNet.doctree
Binary file not shown.
Binary file modified
BIN
-3.86 KB
(74%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/MODIS.doctree
Binary file not shown.
Binary file modified
BIN
-3.85 KB
(72%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/ScalarCSV.doctree
Binary file not shown.
Binary file modified
BIN
+306 Bytes
(100%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/ScalarGRF.doctree
Binary file not shown.
Binary file modified
BIN
+203 Bytes
(100%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/Shape.doctree
Binary file not shown.
Binary file modified
BIN
-4.15 KB
(70%)
docs/html/.doctrees/sections/Dataloaders/scalar/implemented/Thickness.doctree
Binary file not shown.
Binary file modified
BIN
-2.38 KB
(82%)
docs/html/.doctrees/sections/Dataloaders/scalar/index.doctree
Binary file not shown.
Binary file modified
BIN
+42.4 KB
(160%)
docs/html/.doctrees/sections/Dataloaders/vector/abstractVector.doctree
Binary file not shown.
Binary file modified
BIN
-3.81 KB
(76%)
docs/html/.doctrees/sections/Dataloaders/vector/implemented/BalticCurrent.doctree
Binary file not shown.
Binary file modified
BIN
-3.75 KB
(76%)
docs/html/.doctrees/sections/Dataloaders/vector/implemented/ERA5Wind.doctree
Binary file not shown.
Binary file modified
BIN
-3.79 KB
(74%)
docs/html/.doctrees/sections/Dataloaders/vector/implemented/NorthSeaCurrent.doctree
Binary file not shown.
Binary file modified
BIN
-4.19 KB
(74%)
docs/html/.doctrees/sections/Dataloaders/vector/implemented/ORAS5Current.doctree
Binary file not shown.
Binary file modified
BIN
-3.74 KB
(76%)
docs/html/.doctrees/sections/Dataloaders/vector/implemented/SOSE.doctree
Binary file not shown.
Binary file modified
BIN
-3.85 KB
(72%)
docs/html/.doctrees/sections/Dataloaders/vector/implemented/VectorCSV.doctree
Binary file not shown.
Binary file modified
BIN
+302 Bytes
(100%)
docs/html/.doctrees/sections/Dataloaders/vector/implemented/VectorGRF.doctree
Binary file not shown.
Binary file modified
BIN
-2.72 KB
(82%)
docs/html/.doctrees/sections/Dataloaders/vector/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
|
Oops, something went wrong.