spacelink 0.1.2

Space link budget calculation package

SpaceLink

A Python library for radio frequency calculations, including antenna modeling, RF conversions, and noise calculations.

Created and maintained by Cascade Space

Features

• Antenna Modeling: Calculate antenna gain, beamwidth, and polarization effects
• RF System Analysis: Model complete RF chains with cascaded elements
• Link Budget Calculations: Comprehensive analysis of radio communication links
• Noise Calculations: System noise temperature and related parameters
• Space Communications: Built-in support for satellite link analysis
• Unit-Aware Calculations: Integrated unit handling for RF parameters

Installation

Quick Install

For users who want to use the package:

pip install spacelink

Development Setup

Prerequisites

1. Python 3.11 or higher
2. Poetry package manager (Install Poetry)

Getting Started

1. Clone the repository:

   git clone https://github.com/cascade-space-co/spacelink.git
   cd spacelink
   

2. Install dependencies:

   poetry install
   

For production use without development tools:

poetry install --without dev

Documentation

The documentation includes API references and technical guides.

To build the documentation locally:

poetry run sphinx-build -b html docs/source docs/build

Contributing

We welcome contributions to the SpaceLink project! To get started, please follow these steps:

1. Read the Guidelines: Review the CONTRIBUTING.md file for detailed instructions on coding style, testing, and project conventions.

2. Set Up Your Environment:

   • Install dependencies using Poetry:

     poetry install
     

3. Run Tests:

   • Ensure all tests pass before submitting your changes:

     poetry run pytest
     

   • Run tests with coverage:

     poetry run pytest --cov=spacelink --cov-report=term-missing
     

   • Run a specific test file:

     poetry run pytest tests/core/test_antenna.py
     

   • Run tests with verbose output:

     poetry run pytest -v
     

4. Follow Code Style:

   • Format your code with Black:

     poetry run black .
     

   • Lint your code with Flake8:

     poetry run flake8 .
     

5. Submit a Pull Request:

   • Push your changes to a feature branch and open a pull request on GitHub.
   • Provide a clear description of your changes and link any related issues.

Thank you for contributing to SpaceLink!

License

MIT License