11# README
22
3- ### Basilisk
3+ ## Basilisk
44
55* [ Summary of Basilisk] ( docs/source/index.rst )
66* [ Release Notes] ( docs/source/Support/bskReleaseNotes.rst )
77
8- ### How do I get set up?
9- The following links contain installation instructions for the supported platforms:
8+ ### Installation
109
11- - [ Setup a macOS Development Environment] ( docs/source/Install/installOnMacOS.rst )
10+ Basilisk can be installed in two ways, either from PyPI or by building from
11+ source.
1212
13- - [ Setup a Linux Development Environment] ( docs/source/Install/installOnLinux.rst )
13+ For most users, installing from PyPI is the easiest and fastest way to get
14+ started. Building from source is recommended if you need to link to external
15+ C++ modules or want to customize the build configuration.
1416
15- - [ Setup a Windows Development Environment ] ( docs/source/Install/installOnWindows.rst )
17+ #### Install from PyPI
1618
19+ The easiest way to get started with Basilisk is to install the prebuilt wheel
20+ from [ PyPI] ( https://pypi.org/project/bsk/ ) :
1721
22+ ``` bash
23+ pip install bsk
24+ ```
25+
26+ This installs the latest stable version with all standard features
27+ (e.g. optical navigation and MuJoCo). See the [ install] ( docs/source/Install.rst )
28+ docs for supported platforms and additional details about the wheels.
29+
30+ #### Build from Source
31+
32+ If you need to use external C++ modules or want to customize the build, follow
33+ the platform-specific setup instructions:
34+
35+ * [ Setup a macOS Development Environment] ( docs/source/Build/installOnMacOS.rst )
36+
37+ * [ Setup a Linux Development Environment] ( docs/source/Build/installOnLinux.rst )
38+
39+ * [ Setup a Windows Development Environment] ( docs/source/Build/installOnWindows.rst )
40+
41+ See the [ Build from Source docs] ( docs/source/Build.rst ) for full details.
1842
1943### Basilisk Development guidelines
2044
2145* [ Contributing] ( CONTRIBUTING.md )
2246* [ Coding Guidelines] ( docs/source/Support/Developer/CodingGuidlines.rst )
2347
24-
2548### Getting Started
49+
2650To get started with Basilisk (BSK), several tutorial python files are provided in the installed package. Within this
27- web page documentation site, they are listed and discussed in the [ integrated example script] ( docs/source/examples/index.rst )
28- page. The
29- documentation lists the scenarios in an order that facilitates learning basic BSK features. The python scripts
51+ web page documentation site, they are listed and discussed in the [ integrated example script] ( docs/source/examples/index.rst ) page.
52+
53+ The documentation lists the scenarios in an order that facilitates learning basic BSK features. The python scripts
3054are stored under ` basilisk/examples ` . A good start would be to run ` scenarioBasicOrbit.py ` .
3155
3256To play with the tutorials, it is suggested the user makes a copy of these tutorial files, and use the copies in order
@@ -45,7 +69,6 @@ for more information.
4569To use the standalone 3D Visualization, download the [ Vizard] ( docs/source/Vizard/VizardDownload.rst ) .
4670This is in development, but does provide a 3D view of many of the simulation states.
4771
48-
4972### Who do I talk to?
5073
5174Questions and answers are fielded in the project's [ Github Discussions] ( https://github.com/AVSLab/basilisk/discussions ) .
0 commit comments