Skip to content

Commit ebc837c

Browse files
danielk333danielk333
authored
Merge pull request #21 from danielk333/develop
Develop
2 parents 701b63d + f0321d7 commit ebc837c

File tree

132 files changed

+10778
-7071
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+10778
-7071
lines changed

‎README.rst‎

Lines changed: 173 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,196 @@ SORTS
22
=========
33

44

5+
Feature list
6+
-------------
7+
8+
* TO BE ADDED
59

6-
Install
10+
11+
Install SORTS
712
-----------------
813

14+
**To install SORTS**
15+
916
.. code-block:: bash
1017
11-
pip install git+https://github.com/danielk333/pyant
12-
pip install git+https://github.com/danielk333/pyorb
13-
1418
git clone https://github.com/danielk333/SORTS
1519
cd sorts
1620
pip install .
1721
22+
The installation can be automatically tested if `pytest` is also installed
1823

24+
.. code-block:: bash
1925
20-
Feature list
21-
-------------
26+
pytest
27+
28+
29+
From scratch
30+
---------------
31+
32+
**Make sure you have Python >= 3.6**
33+
34+
To install Python 3.7 (from the deadsnakes ppa) on Ubuntu 16 (WARNING: This method differs on Ubuntu 18/20)
35+
36+
.. code-block:: bash
37+
38+
sudo apt update
39+
sudo apt install software-properties-common
40+
sudo add-apt-repository ppa:deadsnakes/ppa
41+
sudo apt update
42+
sudo apt install python3.7
43+
sudo apt install python3.7-venv
44+
45+
It is recommended to use virtual environments when installing `sorts`
46+
47+
.. code-block:: bash
48+
49+
python3.7 -m venv /path/to/new/sorts/environment
50+
source /path/to/new/sorts/environment/bin/activate
51+
52+
Now you should be inside the new virtual environment. Check this by
53+
54+
.. code-block:: bash
55+
56+
pip --version
57+
58+
And you should see the path to "/path/to/new/sorts/environment".
59+
60+
Alternatively if you want to use pip with Python 3.7 without using `venv`, the get-pip.py method can be used. WARNING: Using the bootstrap solution will break your current Python 2.7/3.5 pip, It is not recommended.
61+
62+
.. code-block:: bash
63+
sudp apt install curl
64+
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
65+
python3.7 get-pip.py --user
66+
67+
68+
Now, regardless of the method, you should make sure you have an up to date pip:
69+
70+
.. code-block:: bash
71+
72+
pip install --upgrade pip
73+
74+
75+
If you do not have git, install it first:
76+
77+
.. code-block:: bash
78+
79+
sudo apt install git
80+
81+
82+
**To install SORTS**
83+
84+
.. code-block:: bash
85+
86+
git clone https://github.com/danielk333/SORTS
87+
cd sorts
88+
pip install .
89+
90+
In case "pyant" or "pyorb" requirements fail on auto-install, run the following commands manually and try again:
91+
92+
.. code-block:: bash
93+
94+
pip install git+https://github.com/danielk333/pyant
95+
pip install git+https://github.com/danielk333/pyorb
96+
97+
98+
Install MPI
99+
--------------
100+
101+
Open MPI on Ubuntu
102+
103+
.. code-block:: bash
104+
105+
sudo apt update
106+
sudo apt install openmpi-bin libopenmpi-dev
107+
pip install mpi4py
108+
109+
110+
MPICH on Ubuntu
111+
112+
.. code-block:: bash
113+
114+
sudo apt-get update
115+
sudo apt install mpich
116+
pip install mpi4py
22117
23-
* stuff
24-
* more stuff
118+
Install Orekit
119+
----------------
120+
121+
Using install script while a virtual environment is active on Ubuntu (from inside the SORTS repository)
122+
123+
.. code-block:: bash
124+
125+
sudo apt-get update
126+
sudo apt-get install openjdk-8-jdk
127+
./install_orekit.sh
128+
129+
130+
Install Pyglow
131+
---------------
132+
133+
Taken from "https://github.com/timduly4/pyglow/"
134+
135+
.. code-block:: bash
136+
137+
git clone git://github.com/timduly4/pyglow.git pyglow
138+
139+
cd pyglow/
140+
pip install -r requirements.txt
141+
make -C src/pyglow/models source
142+
python setup.py install
25143
26144
27145
Example
28146
---------------
29147

148+
Finding passes over radar system
30149

31150
.. code-block:: python
32151
33-
import sorts
152+
#!/usr/bin/env python
153+
154+
import numpy as np
155+
import pyorb
156+
157+
import sorts
158+
from sorts.propagator import SGP4
159+
160+
eiscat3d = sorts.radars.eiscat3d
161+
162+
prop = SGP4(
163+
settings = dict(
164+
out_frame='ITRS',
165+
),
166+
)
167+
168+
orb = pyorb.Orbit(
169+
M0 = pyorb.M_earth,
170+
direct_update=True,
171+
auto_update=True,
172+
degrees=True,
173+
a=7200e3,
174+
e=0.05,
175+
i=75,
176+
omega=0,
177+
Omega=79,
178+
anom=72,
179+
epoch=53005.0,
180+
)
181+
print(orb)
182+
183+
t = sorts.equidistant_sampling(
184+
orbit = orb,
185+
start_t = 0,
186+
end_t = 3600*24*1,
187+
max_dpos=1e3,
188+
)
189+
190+
states = prop.propagate(t, orb.cartesian[:,0], orb.epoch)
191+
192+
passes = eiscat3d.find_passes(t, states)
193+
194+
print(passes)
34195
35196
36197
For developers
@@ -41,7 +202,7 @@ To install developer dependencies
41202

42203
.. code-block:: bash
43204
44-
pip install -e .[dev]
205+
#NOT YET AVALIBLE
45206
46207
47208
To test
@@ -56,6 +217,8 @@ To test
56217
To make doc
57218
-----------------
58219

220+
**THIS MAKE TARGET NEEDS UPDATE** (currently manually handled with `make html` instead)
221+
59222
.. code-block:: bash
60223
61224
git checkout gh-pages

‎docsrc/source/api.rst‎

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ Modules
99
:template: autosummary/module.rst
1010
:toctree: _autodoc/sorts
1111

12-
sorts.space_object
13-
sorts.passes
14-
sorts.functions
1512
sorts.constants
16-
sorts.frames
13+
sorts.correlator
1714
sorts.dates
15+
sorts.frames
16+
sorts.functions
17+
sorts.interpolation
18+
sorts.passes
1819
sorts.profiling
1920
sorts.signals
21+
sorts.simulation
22+
sorts.space_object
2023

2124

2225
Sub-packages
@@ -45,6 +48,7 @@ population
4548

4649
sorts.population.population
4750
sorts.population.master
51+
sorts.population.tles
4852

4953

5054
controller
@@ -58,6 +62,7 @@ controller
5862
sorts.controller.radar_controller
5963
sorts.controller.scanner
6064
sorts.controller.tracker
65+
sorts.controller.static
6166

6267

6368

@@ -79,18 +84,52 @@ scheduler
7984
errors
8085
-------------
8186

87+
.. autosummary::
88+
:template: autosummary/module.rst
89+
:toctree: _autodoc/sorts/errors
90+
91+
92+
sorts.errors.errors
93+
sorts.errors.ionospheric_ray_trace
94+
sorts.errors.linearized_coded
95+
8296

8397
io
8498
-------------
8599

100+
.. autosummary::
101+
:template: autosummary/module.rst
102+
:toctree: _autodoc/sorts/io
103+
104+
105+
sorts.io.ccsds
106+
86107

87108
plotting
88109
-------------
89110

111+
.. autosummary::
112+
:template: autosummary/module.rst
113+
:toctree: _autodoc/sorts/plotting
114+
115+
116+
sorts.plotting.general
117+
sorts.plotting.radar
118+
sorts.plotting.scan
119+
sorts.plotting.tracking
120+
121+
90122

91123
radar
92124
-------------
93125

126+
.. autosummary::
127+
:template: autosummary/module.rst
128+
:toctree: _autodoc/sorts/radar
129+
130+
131+
sorts.radar.radar
132+
sorts.radar.tx_rx
94133

95134

96135
scans
@@ -106,6 +145,8 @@ scans
106145
sorts.radar.scans.random_uniform
107146
sorts.radar.scans.fence
108147
sorts.radar.scans.plane
148+
sorts.radar.scans.bp
149+
109150

110151

111152
Instances

‎docsrc/source/index.rst‎

Lines changed: 12 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -11,61 +11,26 @@ SORTS
1111

1212

1313
.. toctree::
14-
:glob:
15-
:maxdepth: 2
16-
:caption: Contents:
17-
18-
introduction/introduction
19-
introduction/*
20-
21-
22-
Features
23-
---------------
24-
25-
* Things
26-
* More Things
27-
28-
29-
30-
Getting started
31-
-----------------
32-
33-
To install (Not yet available)
34-
35-
.. code-block:: bash
36-
37-
pip install pyant
38-
39-
or
40-
41-
.. code-block:: bash
42-
43-
pip install git+https://github.com/danielk333/pyant
44-
pip install git+https://github.com/danielk333/pyorb
14+
:maxdepth: 3
4515

46-
git clone https://github.com/danielk333/SORTS
47-
cd sorts
48-
pip install .
49-
50-
51-
Examples
52-
---------
16+
intro
17+
install
18+
auto_gallery/index
19+
api
5320

54-
Example gallery of the different modular functionality of the toolbox.
5521

56-
.. toctree::
57-
:maxdepth: 2
22+
When used for publications
23+
---------------------------
5824

59-
auto_gallery/index
25+
Please let us known before publishing data using SORTS and use the below Reference/DOI
6026

27+
DOI/TO.BE.ADDED
6128

62-
API Reference
63-
===============
6429

65-
.. toctree::
66-
:maxdepth: 3
30+
License
31+
---------
6732

68-
api
33+
.. include:: ../../../LICENSE
6934

7035

7136

0 commit comments

Comments
 (0)