diff --git a/.DS_Store b/.DS_Store index 6650266..6b02d64 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/docs-src/2_guides/telecom.md b/docs-src/2_guides/telecom.md index 6875c2e..8537de7 100644 --- a/docs-src/2_guides/telecom.md +++ b/docs-src/2_guides/telecom.md @@ -8,4 +8,14 @@ distance between them and any obstructions or media in the communication path. The availability of a communication link depends on whether there is an occultation of some body between the transmitter and receiver, whether the transmitter or receiver is able to be pointed towards the other, and whether the transmitter -or receiver has been allocated for a different purpose and is busy. \ No newline at end of file +or receiver has been allocated for a different purpose and is busy. + +```{math} + (a + b)^2 = a^2 + 2ab + b^2 + + (a - b)^2 = a^2 - 2ab + b^2 +``` + +https://www.mathworks.com/discovery/link-budget.html + +http://www.sss-mag.com/pdf/an9804.pdf \ No newline at end of file diff --git a/docs-src/common-errors.md b/docs-src/common-errors.md new file mode 100644 index 0000000..2a7d17a --- /dev/null +++ b/docs-src/common-errors.md @@ -0,0 +1,17 @@ +# Common Errors + +This section describes some errors you might encounter, and what to do about them + +## ImportError - circular import + +``` +ImportError: cannot import name '...' from partially initialized module 'mission' (most likely due to a circular import) +``` + +This error means you have two python files that import each other. This can occur if you have an activity defined in +one file, and a model in another, and the two reference each other. + +The recommended practice here is _not_ to import activities from the model file - activities should reference the model, +not the other way around. The activity files will need to be imported from your main file prior to running simulation. +Convenient as it may seem, we do _not_ recommend using your model file as your main file - make a separate `main.py` and +import both the model and the activities. diff --git a/docs-src/index.md b/docs-src/index.md index c43100a..37331a9 100644 --- a/docs-src/index.md +++ b/docs-src/index.md @@ -31,6 +31,7 @@ quickstart 2_guides/index 3_explanation/index apidocs/index +common-errors ``` ```{toctree} diff --git a/docs/1_tutorials/1_gettingstarted.html b/docs/1_tutorials/1_gettingstarted.html index 13a8d2d..24982cb 100644 --- a/docs/1_tutorials/1_gettingstarted.html +++ b/docs/1_tutorials/1_gettingstarted.html @@ -243,6 +243,7 @@ +