2
2
3
3
### Basilisk
4
4
5
- * [ Summary of Basilisk] ( http://hanspeterschaub.info/basilisk/index.html )
6
- * [ Versions] ( http://hanspeterschaub.info/basilisk/Support/bskReleaseNotes.html )
5
+ * [ Summary of Basilisk] ( docs/source/index.rst )
7
6
8
7
### How do I get set up?
9
8
The following links contain installation instructions for the supported platforms:
10
9
11
- - [ Setup a macOS Development Environment] ( http://hanspeterschaub.info/basilisk/ Install/installOnMacOS.html )
10
+ - [ Setup a macOS Development Environment] ( docs/source/ Install/installOnMacOS.rst )
12
11
13
- - [ Setup a Linux Development Environment] ( http://hanspeterschaub.info/basilisk/ Install/installOnLinux.html )
12
+ - [ Setup a Linux Development Environment] ( docs/source/ Install/installOnLinux.rst )
14
13
15
- - [ Setup a Windows Development Environment] ( http://hanspeterschaub.info/basilisk/ Install/installOnWindows.html )
14
+ - [ Setup a Windows Development Environment] ( docs/source/ Install/installOnWindows.rst )
16
15
17
16
18
17
19
18
### Basilisk Development guidelines
20
-
21
- * [ Coding Guidelines] ( http://hanspeterschaub.info/basilisk/ Support/Developer/CodingGuidlines.html )
19
+ * [ Contributing ] ( CONTRIBUTING.md )
20
+ * [ Coding Guidelines] ( docs/source/ Support/Developer/CodingGuidlines.rst )
22
21
23
22
24
23
### Getting Started
25
- To get started with Basilisk (BSK), several tutorial python files are provided in the installed package. Within this
26
- web page documentation site, they are listed and discussed in the <a href =" modules.html " >Manual</a > tab. The
27
- documentation lists the scenarios in an order that facilitates learning basic BSK features. In the source code they
24
+ To get started with Basilisk, several tutorials are provided. The
25
+ documentation lists the scenarios in an order that facilitates learning basic Basilisk features. In the source code they
28
26
are stored under ` src\examples\ ` . A good start would be to run ` scenarioBasicOrbit.py ` .
29
27
30
- To play with the tutorials, it is suggested the user makes a copy of these tutorial files, and use the copies in order
31
- to learn, test and experiment. To copy them, first find the location of the Basilisk installation. After installing,
32
- you can find the installed location of Basilisk by opening a python interpreter and running:
33
-
34
- ```
35
- import Basilisk
36
- basiliskPath = Basilisk.__path__[0]
37
- print(basiliskPath)
38
- ```
28
+ To run with the tutorials, it is suggested the user makes a copy of these tutorial files, and use the copies in order
29
+ to learn, test and experiment. Copy the folder ` {basiliskPath}/src/examples ` into a new folder, and change to that
30
+ directory.
39
31
40
- Now copy the folder ` {basiliskPath}/src/examples ` into a new folder, and change to that directory.
41
-
42
- To run the default scenario 1 of scenarioBasicOrbit, in the directory of the copied tutorials, call the python
32
+ To run the default scenario of ` scenarioBasicOrbit ` , in the directory of the copied tutorials, execute the python
43
33
script: ` python3 scenarioBasicOrbit.py `
44
34
45
-
46
35
Now, when you want to use a tutorial, navigate inside that folder, and edit and execute the * copied* integrated tests.
47
36
48
37
<!-- Any new BSK module development should not occur within the BSK folder as this will be updated rapidly. Rather,
@@ -58,4 +47,4 @@ This is in development, but does provide a 3D view of many of the simulation sta
58
47
59
48
### Who do I talk to?
60
49
61
- Questions and answers are fielded in the project's [ Github Discussions] ( https://github.com/AVSLab /basilisk/discussions ) .
50
+ Questions and answers are fielded in the project's [ Github Discussions] ( https://github.com/lasp /basilisk/discussions ) .
0 commit comments