You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ CamPyRoS (Cambridge Python Rocketry Simulator) is a Python package which provide
8
8
- Use of live wind data
9
9
- Variable mass and moments of inertia models
10
10
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/)
12
12
13
13
## Getting started
14
14
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:
Copy file name to clipboardExpand all lines: docs/source/index.rst
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Currently not all dependancies are supported by the same install methods so the
22
22
23
23
The "wind" and "statistics" modules will not run. Statistics has a dependancy not fully supported by windows, to install it:
24
24
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>`_.
26
26
27
27
Wind depends on a library called iris which can only be installed with conda:
28
28
@@ -32,7 +32,7 @@ Wind depends on a library called iris which can only be installed with conda:
32
32
conda install iris, iris_grib
33
33
34
34
.. 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.
36
36
37
37
This may then demand you install another library when you try to run it:
38
38
@@ -61,22 +61,22 @@ The repository contains some examples you can run:
61
61
62
62
Helping out
63
63
===========
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>`_
65
65
66
66
67
67
In progress
68
68
===========
69
69
- **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>`_.
71
71
- **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)
72
72
73
73
74
74
Potential for expansion
75
75
=======================
76
76
- **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)
- **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>`_
[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>`_
91
91
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>`_
93
93
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>`_
95
95
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>`_
97
97
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>`_
99
99
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>`_
101
101
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>`_
0 commit comments