Merge branch 'main' into guhan/isr-logging

Author: guhansiyer

README.md

@@ -6,7 +6,9 @@ This repository holds all the code written by UW Orbital's firmware team. This i
 
 - [Getting Started](#getting-started)
 - [Contributing](#contributing)
-- [Style Guide](#style-guide)
+- [C Style Guide](#c-style-guide)
+- [Python Style Guide](#python-style-guide)
+- [Pytest Style Guide](#pytest-style-guide)
 - [Authors](#authors)
 
 **[Back to top](#table-of-contents)**
@@ -181,7 +183,7 @@ We use Code Composer Studio for debugging the firmware. **TODO**: Write a tutori
 
 **[Back to top](#table-of-contents)**
 
-## Style Guide
+## C Style Guide
 
 ### Comments
 
@@ -246,6 +248,195 @@ Some of these rules don't apply in certain cases. Use your better judgement. To
 
 **[Back to top](#table-of-contents)**
 
+## Python Style Guide
+
+- We will be following the Python language style guide [PEP8](https://peps.python.org/pep-0008/)
+- If there are any discrepancies between this style guide and PEP8, this style guide takes precedence.
+
+### Type Hinting Convention
+
+All function and method parameters (except for the `self` and `cls` parameters) and return signatures should be type hinted.
+
+```python
+def my_add(num1: int, num2: int) -> int:
+	"""
+	@brief Adds two numbers together
+
+	@param num1 - The first number to add.
+	@param num2 - The second number to add.
+	@return Returns the sum of the two numbers.
+	"""
+	return num1 + num2
+```
+
+### Comments
+
+#### Single Line Comments
+
+Variable and function names should be descriptive enough to understand even without comments. Comments are needed to describe any complicated logic. Use `#` for single-line comments.
+
+#### Function and Method Comments
+
+Function and method comments using `""" """` should exist below the function declaration. For methods, the `self` or `cls` parameter does not require a description.
+
+```python
+def my_add(num1: int, num2: int) -> int:
+	"""
+	@brief Adds two numbers together
+
+	@param num1 - The first number to add.
+	@param num2 - The second number to add.
+	@return Returns the sum of the two numbers.
+	"""
+	return num1 + num2
+```
+
+```python
+def increase_x(self, count: int) -> None:
+	"""
+	@brief Increases the x attribute by the count.
+
+	@param count - Count to increase the x attribute by.
+	"""
+	self.x += count
+```
+
+#### File Header Comments
+
+File comments are not required
+
+#### Class Comments
+
+- Class comments should exist after the class definition
+- Provide a brief description given class purpose
+- Provide a section in the class comment listing the attributes, their type and purpose
+- Enum class comments do not require listing the attributes
+
+```python
+class PointTwoDimension:
+	"""
+	@brief Class for storing a 2D point
+	@attribute x (int) - x coordinate of the point
+	@attribute y (int) - y coordinate of the point
+	"""
+
+	def __init__(x: int, y: int):
+		self.x = x
+		self.y = y
+
+@dataclasses.dataclass
+class PointTwoDimension:
+	"""
+	@brief Class for storing a 2D point
+	@attribute x (int) - x coordinate of the point
+	@attribute y (int) - y coordinate of the point
+	"""
+
+	x: int
+	y: int
+```
+ ```python
+import enum
+
+# No comments required
+class ErrorCode(enum.Enum):
+    """
+    @brief Enum for the error codes
+    """
+
+    SUCCESS = 0
+    INVALID_ARG = 1
+```
+
+### Naming Conventions
+
+- `variable_names`, `field_names` and `function_constants` in snake_case
+- `_private_field_names`, and `_private_method_names()` in \_snake_case
+- `function_names()` and `method_names()` in snake_case
+- `CONSTANT_NAMES: Final` and `ENUM_OPTIONS` in CAPITAL_SNAKE_CASE for module and class constants (not for local constant)
+- `file_names` in snake_case
+- `ClassName` in PascalCase
+    ```python
+    # For brevity, the class comments were removed but they should be in real code
+    import dataclasses
+
+    @dataclasses.dataclass
+    class PointTwoDimension:
+    	x: int
+    	y: int
+
+    class PointTwoDimension:
+    	def __init__(x: int, y: int):
+    		self.x = x
+    		self.y = y
+    ```
+
+
+- `EnumName` in PascalCase
+
+    ```python
+    import enum
+
+    class ErrorCode(enum.Enum):
+    	SUCCESS = 0
+    	INVALID_ARG = 1
+
+    # Accessing:
+    ErrorCode.SUCCESS  # <ErrorCode.SUCCESS: 0>
+    ErrorCode.INVALID_ARG  # <ErrorCode.INVALID_ARG: 1>
+    ```
+
+### Imports
+
+#### Grouping Imports
+
+- Local imports (e.g. `import cc1120_driver`)
+- External library imports (e.g. `import requests`)  (Must be included in the `requirements.txt`)
+- Standard library imports (e.g. `import math`)
+
+#### Notes about imports
+
+- Imports should only be used at the top of the file (no function or scoped imports)
+- Only modules should be imported
+
+```python
+# module1 contains very_long_module_name and function foo and variable var.
+#   very_long_module_name contains bar
+
+# Yes:
+from module1 import very_long_module_name as module2  # Casting to shorter name
+import module1
+
+module1.foo()
+module1.var
+module2.bar()
+
+# No:
+from module1.very_long_module_name import bar
+from module1 import foo, var
+
+foo()
+var
+bar()
+```
+
+### Other Style Guide Points
+
+- Only imports, function, class, and constants declarations and the `if __name__ == '__main__'` should be in module scope
+- Entry point to a script or program should be through the `main` function
+- Use double quotes for strings `"` over single quotes `'`
+- Add a trailing comma after elements of a list, if you wish to make/preserve each element on a separate line
+
+**[Back to top](#table-of-contents)**
+
+## Pytest Style Guide
+
+- All functions that are to be tested should go into a Python file starting with `test_`
+- All functions that are to be tested **must** start with `test_` (This is a Pytest requirement)
+- Type hints are optional for Pytest functions (functions that start with `test_` in a Pytest file)
+
+**[Back to top](#table-of-contents)**
+
 ## Authors
 This codebase was developed by the members of UW Orbital, the University of Waterloo's CubeSat design team.
 

gs/sun/README.md

@@ -14,8 +14,8 @@ usage: ephemeris.py [-h] [-s STEP_SIZE] [-t TARGET] [-o OUTPUT] [-d] [-p {0,1,2}
 Position Ephemeris Retriever
 
 positional arguments:
--  start_time            Start time in the format YYYY-MM-DD or JD#
--  stop_time             Stop time in the format YYYY-MM-DD or JD#
+-  start_time            Start time in the format YYYY-MM-DD or JD#. Must be the same format as stop time.
+-  stop_time             Stop time in the format YYYY-MM-DD or JD#. Must be the same format as start time.
 
 options:
 -  -h, --help           <br>