ubc-solar-physics 0.1.11__tar.gz → 1.0.5__tar.gz

ubc_solar_physics-1.0.5/.github/pull_request_template.md

@@ -0,0 +1 @@
+# Physics Pull Request Template

ubc_solar_physics-1.0.5/.github/workflows/build_and_publish.yaml

@@ -0,0 +1,110 @@
+# This workflow is maintained according to STG Specification #2: Physics Publishing
+
+name: Build and Publish Wheels
+
+on:
+#  workflow_run:  # THIS IS DISABLED BECAUSE IT PROBABLY DOESN'T WORK!
+#    workflows: ["Run Tests"]
+#    types:
+#      - completed
+
+  release:  # This workflow will be triggered upon a release being published on GitHub
+    types:
+      - published
+
+  workflow_dispatch:  # Enable manual dispatching of this workflow
+
+jobs:
+  build_sdist:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Required to fetch full history including tags, so setuptools_scm can determine version
+
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.9'
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine==5.1.1 
+
+      - name: Build Source Distribution
+        run: |
+          python3 -m build --sdist
+
+      - name: Upload sdist to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+
+
+  build_wheels:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false  # Without this, one of the wheels failing for some reason would cancel all of the others.
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]  # Build wheels for macOS and Windows, and Linux.
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Required to fetch full history including tags, so setuptools_scm can determine version
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+
+      # We run `python -m setuptools_scm` and `git status` for debugging purposes, to verify that
+      # setuptools_scm is properly identifying the version based on the tag
+      - name: Install and prepare build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools_scm==8.1.0 twine==5.1.1 setuptools_rust cibuildwheel==2.20.0
+          python -m setuptools_scm 
+          git status
+
+      # This gives us access to a Rust compiler
+      - name: Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      # We need to make all of possible architectures that we want wheels for available for Rust to compile for
+      - name: Add Rust targets
+        run: |
+          rustup target add x86_64-apple-darwin || echo "x86_64-apple-darwin target already added"
+          rustup target add aarch64-apple-darwin || echo "aarch64-apple-darwin target already added"
+          rustup target add x86_64-unknown-linux-gnu || echo "Linux target already added"
+          rustup target add x86_64-pc-windows-msvc || echo "Windows target already added"
+        shell: bash
+
+      # Now, we use cibuildwheel to build all the wheels that we want for the platforms we defined in matrix.os
+      # It will build wheels for Python versions that are allowed based on our pyproject.toml
+      - name: Build wheels
+        run: cibuildwheel --output-dir dist
+        env:
+          CIBW_ARCHS_MACOS: "x86_64 arm64"  # Make sure both x86_64 and arm64 wheels are built for macOS
+          CIBW_ENVIRONMENT: 'PATH="$HOME/.cargo/bin:$PATH"'
+          CIBW_ENVIRONMENT_WINDOWS: 'PATH="$UserProfile\.cargo\bin;$PATH"'
+          CIBW_BEFORE_BUILD: >
+            pip install -U setuptools-rust &&
+            rustup default nightly &&
+            rustup show
+          CIBW_BEFORE_BUILD_LINUX: >
+            pip install -U setuptools-rust &&
+            curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain=nightly --profile=minimal -y &&
+            rustup show
+
+      - name: Upload wheels to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}

ubc_solar_physics-1.0.5/.github/workflows/run_tests.yaml

@@ -0,0 +1,43 @@
+# This workflow is maintained according to STG Specification #2: Physics Publishing
+
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Run Tests
+
+on: [push]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+
+    - name: Set up Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+
+    - name: Add Rust targets
+      run: |
+        rustup target add x86_64-unknown-linux-gnu || echo "Linux target already added"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools_scm setuptools_rust pytest==8.3.3
+        pip install .
+
+    - name: Test with pytest
+      run: |
+        pytest

{ubc_solar_physics-0.1.11 → ubc_solar_physics-1.0.5}/.gitignore

@@ -20,6 +20,7 @@ parts/
 sdist/
 var/
 wheels/
+wheelhouse/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -160,3 +161,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
+
+# Setuptools_scm
+physics/_version.py

ubc_solar_physics-1.0.5/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/docs_requirements.txt
+
+sphinx:
+  configuration: docs/source/conf.py

{ubc_solar_physics-0.1.11/ubc_solar_physics.egg-info → ubc_solar_physics-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ubc-solar-physics
-Version: 0.1.11
+Version: 1.0.5
 Summary: UBC Solar's Simulation Environment
 Author: Fisher Xue, Mihir Nimgade, Chris Chang, David Widjaja, Justin Hua, Ilya Veksler, Renu Rajamagesh, Ritchie Xia, Erik Langille, Chris Aung, Nicolas Ric, Ishaan Trivedi, Jason Liang, Felix Toft, Mack Wilson, Jonah Lee, Tamzeed Quazi, Joshua Riefman
 Author-email: UBC Solar <strategy@ubcsolar.com>
@@ -30,7 +30,7 @@ License: MIT License
         
 Project-URL: Homepage, https://ubcsolar.com
 Project-URL: Repository, https://github.com/UBC-Solar/physics
-Project-URL: Documentation, https://wiki.ubcsolar.com
+Project-URL: Documentation, https://ubc-solar-physics.readthedocs.io/en/latest/
 Keywords: car,simulation,solar
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
@@ -43,7 +43,6 @@ Requires-Dist: backports.tarfile==1.2.0
 Requires-Dist: certifi==2024.7.4
 Requires-Dist: charset-normalizer==3.3.2
 Requires-Dist: dill==0.3.8
-Requires-Dist: docutils==0.21.2
 Requires-Dist: haversine==2.8.1
 Requires-Dist: idna==3.7
 Requires-Dist: importlib_metadata==8.2.0
@@ -53,7 +52,6 @@ Requires-Dist: jaraco.functools==4.0.2
 Requires-Dist: keyring==25.3.0
 Requires-Dist: llvmlite==0.43.0
 Requires-Dist: markdown-it-py==3.0.0
-Requires-Dist: maturin==1.7.0
 Requires-Dist: mdurl==0.1.2
 Requires-Dist: more-itertools==10.4.0
 Requires-Dist: nh3==0.2.18
@@ -67,9 +65,71 @@ Requires-Dist: requests-toolbelt==1.0.0
 Requires-Dist: rfc3986==2.0.0
 Requires-Dist: rich==13.7.1
 Requires-Dist: tqdm==4.66.5
-Requires-Dist: twine==5.1.1
 Requires-Dist: urllib3==2.2.2
 Requires-Dist: zipp==3.20.0
 
-# physics
-UBC Solar's physics and environment models for simulating our groundbreaking solar cars 
+# UBC Solar Physics
+
+<!-- marker-index-start -->
+
+[![Documentation Status](https://readthedocs.org/projects/ubc-solar-physics/badge/?version=latest)](https://ubc-solar-physics.readthedocs.io/en/latest/?badge=latest)
+
+UBC Solar's physics and environment models for simulating our groundbreaking solar cars.
+
+The API is currently unstable, and backwards compatibility may not be maintained. 
+
+## Requirements
+
+Versions indicated are recommended
+
+* Git [^1]
+* Python >=3.9 [^2]
+* Rustc >=1.79.0 [^3]
+* Cargo >=1.79.0 [^4]
+
+## Installation
+
+First, clone this repository.
+
+```bash
+git clone https://github.com/UBC-Solar/physics.git
+```
+Then, create and activate a virtual environment.
+Next, install dependencies in editable mode.
+
+```bash
+pip3 install -e .
+```
+
+## Getting Started
+
+Example of calculating solar arrays produced energy
+
+```python
+from physics.models.arrays import BasicArray
+import numpy as np
+
+efficiency = 0.25  # 25.0% efficient
+panel_size = 4.0   # 4.0m^2 of panels
+tick = 1.0         # 1.0s interval
+
+arrays = BasicArray(panel_efficiency=efficiency, panel_size=panel_size)
+
+irradiance = np.full([5], 400.0)  # 10 seconds of 400.0W/m^2 irradiance
+
+solar_power_produced = arrays.calculate_produced_energy(solar_irradiance=irradiance, tick=tick)
+
+assert np.array_equal(solar_power_produced, np.array([400.0, 400.0, 400.0, 400.0, 400.0]))
+```
+
+## Appendix
+
+[^1]: use `git --version` to verify version
+
+[^2]: use `python3 --version` to verify version
+
+[^3]: use `rustc --version` to verify version
+
+[^4]: use `cargo --version` to verify version
+
+<!-- marker-index-end -->

ubc_solar_physics-1.0.5/README.md

@@ -0,0 +1,65 @@
+# UBC Solar Physics
+
+<!-- marker-index-start -->
+
+[![Documentation Status](https://readthedocs.org/projects/ubc-solar-physics/badge/?version=latest)](https://ubc-solar-physics.readthedocs.io/en/latest/?badge=latest)
+
+UBC Solar's physics and environment models for simulating our groundbreaking solar cars.
+
+The API is currently unstable, and backwards compatibility may not be maintained. 
+
+## Requirements
+
+Versions indicated are recommended
+
+* Git [^1]
+* Python >=3.9 [^2]
+* Rustc >=1.79.0 [^3]
+* Cargo >=1.79.0 [^4]
+
+## Installation
+
+First, clone this repository.
+
+```bash
+git clone https://github.com/UBC-Solar/physics.git
+```
+Then, create and activate a virtual environment.
+Next, install dependencies in editable mode.
+
+```bash
+pip3 install -e .
+```
+
+## Getting Started
+
+Example of calculating solar arrays produced energy
+
+```python
+from physics.models.arrays import BasicArray
+import numpy as np
+
+efficiency = 0.25  # 25.0% efficient
+panel_size = 4.0   # 4.0m^2 of panels
+tick = 1.0         # 1.0s interval
+
+arrays = BasicArray(panel_efficiency=efficiency, panel_size=panel_size)
+
+irradiance = np.full([5], 400.0)  # 10 seconds of 400.0W/m^2 irradiance
+
+solar_power_produced = arrays.calculate_produced_energy(solar_irradiance=irradiance, tick=tick)
+
+assert np.array_equal(solar_power_produced, np.array([400.0, 400.0, 400.0, 400.0, 400.0]))
+```
+
+## Appendix
+
+[^1]: use `git --version` to verify version
+
+[^2]: use `python3 --version` to verify version
+
+[^3]: use `rustc --version` to verify version
+
+[^4]: use `cargo --version` to verify version
+
+<!-- marker-index-end -->

ubc_solar_physics-1.0.5/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

ubc_solar_physics-1.0.5/docs/_generate_version.py

@@ -0,0 +1,11 @@
+from setuptools_scm import get_version
+from pathlib import Path
+
+# Get the version from setuptools_scm
+version = get_version()
+
+# Path to the version file specified in your pyproject.toml
+version_file = Path('physics/_version.py')
+
+# Write the version into _version.py
+version_file.write_text(f"__version__ = '{version}'\n")

ubc_solar_physics-1.0.5/docs/docs_requirements.txt

@@ -0,0 +1,53 @@
+alabaster
+babel
+backports.tarfile
+build
+certifi
+charset-normalizer
+dill
+docutils
+haversine
+idna
+imagesize
+importlib_metadata
+jaraco.classes
+jaraco.context
+jaraco.functools
+Jinja2
+keyring
+llvmlite
+markdown-it-py
+MarkupSafe
+mdit-py-plugins
+mdurl
+more-itertools
+myst-parser
+nh3
+numba
+numpy
+packaging
+pkginfo
+Pygments
+pyproject_hooks
+PyYAML
+readme_renderer
+requests
+requests-toolbelt
+rfc3986
+rich
+snowballstemmer
+Sphinx
+sphinx-autodoc-typehints
+sphinx-rtd-theme==2.0.0
+sphinxcontrib-applehelp
+sphinxcontrib-devhelp
+sphinxcontrib-htmlhelp
+sphinxcontrib-jquery
+sphinxcontrib-jsmath
+sphinxcontrib-qthelp
+sphinxcontrib-serializinghtml
+tqdm
+urllib3
+zipp
+setuptools_scm
+pydata-sphinx-theme==0.15.4

ubc_solar_physics-1.0.5/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

ubc_solar_physics-1.0.5/docs/source/README.md

@@ -0,0 +1,63 @@
+# UBC Solar Physics
+
+<!-- marker-index-start -->
+
+UBC Solar's physics and environment models for simulating our groundbreaking solar cars.
+
+The API is currently unstable, and backwards compatibility may not be maintained. 
+
+## Requirements
+
+Versions indicated are recommended
+
+* Git [^1]
+* Python >=3.9 [^2]
+* Rustc >=1.79.0 [^3]
+* Cargo >=1.79.0 [^4]
+
+## Installation
+
+First, clone this repository.
+
+```bash
+git clone https://github.com/UBC-Solar/physics.git
+```
+Then, create and activate a virtual environment.
+Next, install dependencies in editable mode.
+
+```bash
+pip3 install -e .
+```
+
+## Getting Started
+
+Example of calculating solar arrays produced energy
+
+```python
+from physics.models.arrays import BasicArray
+import numpy as np
+
+efficiency = 0.25  # 25.0% efficient
+panel_size = 4.0   # 4.0m^2 of panels
+tick = 1.0         # 1.0s interval
+
+arrays = BasicArray(panel_efficiency=efficiency, panel_size=panel_size)
+
+irradiance = np.full([5], 400.0)  # 10 seconds of 400.0W/m^2 irradiance
+
+solar_power_produced = arrays.calculate_produced_energy(solar_irradiance=irradiance, tick=tick)
+
+assert np.array_equal(solar_power_produced, np.array([400.0, 400.0, 400.0, 400.0, 400.0]))
+```
+
+## Appendix
+
+[^1]: use `git --version` to verify version
+
+[^2]: use `python3 --version` to verify version
+
+[^3]: use `rustc --version` to verify version
+
+[^4]: use `cargo --version` to verify version
+
+<!-- marker-index-end -->

ubc_solar_physics-1.0.5/docs/source/api.rst

@@ -0,0 +1,9 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 3
+   :caption: API Reference
+
+   environment/index
+   models/index

ubc_solar_physics-1.0.5/docs/source/conf.py

@@ -0,0 +1,50 @@
+from setuptools_scm import get_version
+from pathlib import Path
+import importlib
+
+# Generate the version file
+version = get_version()
+version_file = Path('physics/_version.py')
+version_file.write_text(f"__version__ = '{version}'\n")
+
+# Dynamically import the version
+importlib.invalidate_caches()
+physics_module = importlib.import_module("physics")
+__version__ = physics_module.__version__
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'UBC Solar Physics'
+copyright = '2024, UBC Solar'
+author = 'Joshua Riefman'
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',   # For Google/NumPy style docstrings
+    'sphinx.ext.autosummary',  # To generate summary tables for modules
+    'myst_parser',           # For Markdown support if needed
+]
+
+html_theme = "pydata_sphinx_theme"
+
+autodoc_mock_imports = ['core']
+source_suffix = ['.rst', '.md']
+
+templates_path = ['_templates']
+exclude_patterns = []
+autosummary_generate = True
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_static_path = ['_static']

ubc_solar_physics-1.0.5/docs/source/environment/gis.rst

@@ -0,0 +1,12 @@
+GIS
+===
+
+.. autoclass:: physics.environment.gis.GIS
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: physics.environment.gis.BaseGIS
+   :members:
+   :undoc-members:
+   :show-inheritance:

ubc_solar_physics-1.0.5/docs/source/environment/index.rst

@@ -0,0 +1,9 @@
+Environment
+============
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Environment
+
+   gis
+   meteorology

ubc_solar_physics-1.0.5/docs/source/environment/meteorology.rst

@@ -0,0 +1,17 @@
+Meteorology
+===========
+
+.. autoclass:: physics.environment.meteorology.BaseMeteorology
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: physics.environment.meteorology.IrradiantMeteorology
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: physics.environment.meteorology.CloudedMeteorology
+   :members:
+   :undoc-members:
+   :show-inheritance:

ubc_solar_physics-1.0.5/docs/source/index.rst

@@ -0,0 +1,20 @@
+.. physics documentation master file, created by
+   sphinx-quickstart on Mon Aug 19 00:13:44 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+UBC Solar Simulation Documentation
+=====================
+
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   README.md
+   api
+
+.. include:: ../../README.md
+  :parser: myst_parser.sphinx_
+  :start-after: <!-- marker-index-start -->
+  :end-before: <!-- marker-index-end -->

ubc_solar_physics-1.0.5/docs/source/models/arrays.rst

@@ -0,0 +1,12 @@
+Solar Arrays
+============
+
+.. autoclass:: physics.models.arrays.BasicArray
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: physics.models.arrays.BaseArray
+   :members:
+   :undoc-members:
+   :show-inheritance: