Skip to content

Commit 2f4894c

Browse files
committed
Fixed links
1 parent d9fd127 commit 2f4894c

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ CamPyRoS (Cambridge Python Rocketry Simulator) is a Python package which provide
88
- Use of live wind data
99
- Variable mass and moments of inertia models
1010

11-
For a fuller documatation see the docs [here](https://cuspaceflight.github.io/CamPyRoS-Docs/)
11+
For a fuller documatation see the docs [here](https://campyros.readthedocs.io/)
1212

1313
## Getting started
1414
Currently not all dependancies are supported by the same install methods so the easiest install doesn't contain the full functionality. To install the core library:

docs/source/index.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Currently not all dependancies are supported by the same install methods so the
2222
2323
The "wind" and "statistics" modules will not run. Statistics has a dependancy not fully supported by windows, to install it:
2424

25-
`pip install ray` on most platforms, for Windows problems see [here](https://docs.ray.io/en/master/installation.html).
25+
`pip install ray` on most platforms, for Windows problems see `here <https://docs.ray.io/en/master/installation.html>`_.
2626

2727
Wind depends on a library called iris which can only be installed with conda:
2828

@@ -32,7 +32,7 @@ Wind depends on a library called iris which can only be installed with conda:
3232
conda install iris, iris_grib
3333
3434
.. note::
35-
Note: after some more testing this won't work for anyone on Windows, I am in the process fo sorting this out (the problem is a codec dependancy which there is no way for us to fix) by writing an library to read the other GFS distrobution method, see [gfspy](https://github.com/jagoosw/gfspy). You can still run and contribute without using the wind module. If you really want to use the wind module please [email]([email protected]) or message me and we can try and sort out access to something remote you can use to run it.
35+
Note: after some more testing this won't work for anyone on Windows, I am in the process fo sorting this out (the problem is a codec dependancy which there is no way for us to fix) by writing an library to read the other GFS distrobution method, see `getgfs <https://github.com/jagoosw/getgfs>`_. You can still run and contribute without using the wind module.
3636

3737
This may then demand you install another library when you try to run it:
3838

@@ -61,22 +61,22 @@ The repository contains some examples you can run:
6161

6262
Helping out
6363
===========
64-
If you would like to contribute please have a look at the [guidelines](CONTRIBUTING.md)
64+
If you would like to contribute please have a look at the `guidelines <https://github.com/cuspaceflight/CamPyRoS/blob/main/CONTRIBUTING.md>`_
6565

6666

6767
In progress
6868
===========
6969
- **GUI:** An incomplete (and outdated) GUI has been made using Tkinter, and is in gui.py.
70-
- **Slosh modelling:** Some slosh modelling functions have been put together in slosh.py, based on the following source - [The Dynamic Behavior of Liquids in Moving Containers, with Applications to Space Vehicle Technology](https://ntrs.nasa.gov/citations/19670006555).
70+
- **Slosh modelling:** Some slosh modelling functions have been put together in slosh.py, based on the following source - `The Dynamic Behavior of Liquids in Moving Containers, with Applications to Space Vehicle Technology <https://ntrs.nasa.gov/citations/19670006555>`_.
7171
- **Wind variability:** Statistical analysis of historic wind forecasts and obervations are analysed to create a Guassian difference profile to vary the wind in the statistical models (see wind-stats branch for a very poorly documented insight to current progress)
7272

7373

7474
Potential for expansion
7575
=======================
7676
- **Multistage rockets**
77-
- **Fin cant, roll damping, and roll acceleration:** [OpenRocket Technical Documentation](http://openrocket.info/documentation.html)
78-
- **CFD coupling:** [PyFoam](https://openfoamwiki.net/index.php/Contrib/PyFoam), [Simulations of 6-DOF Motion with a Cartesian Method](https://pdfs.semanticscholar.org/ace3/5a61803390b0e0b70f6ca34492ad20a03e03.pdf)
79-
- **Multiphysics coupling:** [PRECICE](https://www.precice.org/)
77+
- **Fin cant, roll damping, and roll acceleration:** `OpenRocket Technical Documentation <http://openrocket.info/documentation.html>`_
78+
- **CFD coupling:** `PyFoam <https://openfoamwiki.net/index.php/Contrib/PyFoam>`_, `Simulations of 6-DOF Motion with a Cartesian Method <https://pdfs.semanticscholar.org/ace3/5a61803390b0e0b70f6ca34492ad20a03e03.pdf>`_
79+
- **Multiphysics coupling:** `PRECICE <https://www.precice.org/>`_
8080

8181
Cite as
8282
=======
@@ -85,23 +85,23 @@ Daniel Gibbons, & Jago Strong-Wright. (2021, February 11). cuspaceflight/CamPyRo
8585
References
8686
==========
8787

88-
[1] - [Stochastic Six-Degree-of-Freedom Flight Simulator for Passively Controlled High-Power Rockets](https://ascelibrary.org/doi/10.1061/%28ASCE%29AS.1943-5525.0000051)
88+
[1] - `Stochastic Six-Degree-of-Freedom Flight Simulator for Passively Controlled High-Power Rockets <https://ascelibrary.org/doi/10.1061/%28ASCE%29AS.1943-5525.0000051>`_
8989

90-
[2] - [Tangent ogive nose aerodynamic heating program: NQLD019](https://ntrs.nasa.gov/citations/19730063810)
90+
[2] - `Tangent ogive nose aerodynamic heating program: NQLD019 <https://ntrs.nasa.gov/citations/19730063810>`_
9191

92-
[3] - [NASA Basic Considerations for Rocket Trajectory Simulation](https://apps.dtic.mil/sti/pdfs/AD0642855.pdf)
92+
[3] - `NASA Basic Considerations for Rocket Trajectory Simulation <https://apps.dtic.mil/sti/pdfs/AD0642855.pdf>`_
9393

94-
[4] - [SIX DEGREE OF FREEDOM DIGITAL SIMULATION MODEL FOR UNGUIDED FIN-STABILIZED ROCKETS](https://apps.dtic.mil/dtic/tr/fulltext/u2/452106.pdf)
94+
[4] - `SIX DEGREE OF FREEDOM DIGITAL SIMULATION MODEL FOR UNGUIDED FIN-STABILIZED ROCKETS <https://apps.dtic.mil/dtic/tr/fulltext/u2/452106.pdf>`_
9595

96-
[5] - [Trajectory Prediction for a Typical Fin Stabilized Artillery Rocket](https://journals.ekb.eg/article_23742_f19c1da1a61e78c1f5bb7ce58a7b30dd.pdf)
96+
[5] - `Trajectory Prediction for a Typical Fin Stabilized Artillery Rocket <https://journals.ekb.eg/article_23742_f19c1da1a61e78c1f5bb7ce58a7b30dd.pdf>`_
9797

98-
[6] - [Central Limit Theorem and Sample Size](https://www.umass.edu/remp/Papers/Smith&Wells_NERA06.pdf)
98+
[6] - `Central Limit Theorem and Sample Size <https://www.umass.edu/remp/Papers/Smith&Wells_NERA06.pdf>`_
9999

100-
[7] - [Monte Carlo Simulations: Number of Iterations and Accuracy](https://apps.dtic.mil/dtic/tr/fulltext/u2/a621501.pdf)
100+
[7] - `Monte Carlo Simulations: Number of Iterations and Accuracy <https://apps.dtic.mil/dtic/tr/fulltext/u2/a621501.pdf>`_
101101

102-
[8] - [Method for Calculating Aerodynamic Heating on Sounding Rocket Tangent Ogive Noses](https://arc.aiaa.org/doi/abs/10.2514/3.62081)
102+
[8] - `Method for Calculating Aerodynamic Heating on Sounding Rocket Tangent Ogive Noses <https://arc.aiaa.org/doi/abs/10.2514/3.62081>`_
103103

104-
[9] - [Six degree-of-freedom (6-DOF) Flight Simulation Check-cases](https://nescacademy.nasa.gov/flightsim/)
104+
[9] - `Six degree-of-freedom (6-DOF) Flight Simulation Check-cases <https://nescacademy.nasa.gov/flightsim/>`_
105105

106106

107107

0 commit comments

Comments
 (0)