Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: aa6de7bb4809089476879e39f32f7dd9
config: c7ef2e0edce5614b95a3d168aacf8abb
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/build/html/.doctrees/development/contributing.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/html/.doctrees/user_guide/installation.doctree
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; openseries 2.1.9 documentation</title>
<title>Overview: module code &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=b36c5fd4" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/openseries/datefixer.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.datefixer &mdash; openseries 2.1.9 documentation</title>
<title>openseries.datefixer &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/openseries/frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.frame &mdash; openseries 2.1.9 documentation</title>
<title>openseries.frame &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/openseries/load_plotly.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.load_plotly &mdash; openseries 2.1.9 documentation</title>
<title>openseries.load_plotly &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/openseries/owntypes.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.owntypes &mdash; openseries 2.1.9 documentation</title>
<title>openseries.owntypes &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
5 changes: 2 additions & 3 deletions docs/build/html/_modules/openseries/portfoliotools.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.portfoliotools &mdash; openseries 2.1.9 documentation</title>
<title>openseries.portfoliotools &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down Expand Up @@ -913,7 +913,6 @@ <h1>Source code for openseries.portfoliotools</h1><div class="highlight"><pre>
<span class="n">filename</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">plotfile</span><span class="p">),</span>
<span class="n">auto_open</span><span class="o">=</span><span class="n">auto_open</span><span class="p">,</span>
<span class="n">auto_play</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">link_text</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span>
<span class="n">include_plotlyjs</span><span class="o">=</span><span class="n">include_plotlyjs</span><span class="p">,</span>
<span class="n">config</span><span class="o">=</span><span class="n">fig</span><span class="p">[</span><span class="s2">"config"</span><span class="p">],</span>
<span class="n">output_type</span><span class="o">=</span><span class="n">output_type</span><span class="p">,</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/openseries/report.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.report &mdash; openseries 2.1.9 documentation</title>
<title>openseries.report &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/openseries/series.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.series &mdash; openseries 2.1.9 documentation</title>
<title>openseries.series &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_modules/openseries/simulation.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.simulation &mdash; openseries 2.1.9 documentation</title>
<title>openseries.simulation &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
22 changes: 8 additions & 14 deletions docs/build/html/_sources/development/contributing.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,19 @@ Development Setup
git clone https://github.com/yourusername/openseries.git
cd openseries

3. Install uv (if not already installed):
3. Create the development environment. This installs the pinned uv version
(``uv==0.11.21``), syncs locked ``dev`` and ``docs`` dependencies from
``uv.lock``, and installs pre-commit hooks:

.. code-block:: bash

pip install uv
make install

4. Create a virtual environment and install dependencies:
On Windows:

.. code-block:: bash

uv venv venv
source venv/bin/activate
uv pip install -e ".[dev,docs]"

5. Install pre-commit hooks:

.. code-block:: bash
.. code-block:: powershell

pre-commit install
.\make.ps1 make

Development Workflow
~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -377,7 +371,7 @@ Recommended settings in ``.vscode/settings.json``:
.. code-block:: json

{
"python.defaultInterpreterPath": ".venv/bin/python",
"python.defaultInterpreterPath": "venv/bin/python",
"python.linting.enabled": true,
"python.linting.ruffEnabled": true,
"python.formatting.provider": "ruff",
Expand Down
47 changes: 24 additions & 23 deletions docs/build/html/_sources/user_guide/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,25 +49,26 @@ openseries automatically installs the following dependencies:
Core Dependencies
~~~~~~~~~~~~~~~~~

- **pandas** (>=2.1.2,<3.0.0) - Data manipulation and analysis
- **numpy** (>=1.23.2,!=2.3.0,<3.0.0) - Numerical computing
- **pydantic** (>=2.5.2,<3.0.0) - Data validation and settings management
- **pandas** (>=2.1.2) - Data manipulation and analysis
- **numpy** (>=1.23.2) - Numerical computing
- **pydantic** (>=2.5.2) - Data validation and settings management
- **plotly** (>=5.18.0) - Interactive plotting
- **scipy** (>=1.11.4,<2.0.0) - Scientific computing
- **scikit-learn** (>=1.4.0,<2.0.0) - Machine learning utilities
- **scipy** (>=1.14.1) - Scientific computing
- **scikit-learn** (>=1.4.0) - Machine learning utilities

Financial and Date Utilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **exchange-calendars** (>=4.8,<6.0) - Trading calendar support
- **holidays** (>=0.30,<1.0) - Holiday calendar support
- **python-dateutil** (>=2.8.2,<4.0.0) - Date parsing utilities
- **exchange-calendars** (>=4.8) - Trading calendar support
- **holidays** (>=0.30) - Holiday calendar support
- **python-dateutil** (>=2.8.2) - Date parsing utilities
- **tzdata** (>=2025.3) - IANA time zone data

File and Network Support
~~~~~~~~~~~~~~~~~~~~~~~~~

- **openpyxl** (>=3.1.2,<5.0.0) - Excel file support
- **requests** (>=2.20.0,<3.0.0) - HTTP library
- **openpyxl** (>=3.1.2) - Excel file support
- **requests** (>=2.20.0) - HTTP library

Optional Dependencies
~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -117,27 +118,27 @@ You can also run a quick test:
Development Installation
------------------------

If you plan to contribute to openseries or need the development dependencies:
If you plan to contribute to openseries or need the development dependencies,
use the same pinned tooling as CI (``uv==0.11.21``):

.. code-block:: bash

git clone https://github.com/CaptorAB/openseries.git
cd openseries
make install

# Install uv (if not already installed)
pip install uv
On Windows, run ``.\make.ps1 make`` instead of ``make install``.

# Create a virtual environment and install dependencies
uv venv venv
source venv/bin/activate
uv pip install -e ".[dev]"
This creates ``venv``, installs locked runtime, development, and documentation
dependencies from ``uv.lock``, and installs pre-commit hooks. Development
dependencies include:

This will install additional development dependencies including:

- **pytest** - Testing framework
- **mypy** - Static type checking
- **ruff** - Linting and formatting
- **pre-commit** - Git hooks for code quality
- **pytest** (>=9.1.0) - Testing framework
- **pytest-cov** (>=7.1.0) - Coverage plugin
- **pytest-xdist** (>=3.8.0) - Parallel test runner
- **mypy** (==2.1.0) - Static type checking
- **ruff** (==0.15.18) - Linting and formatting
- **pre-commit** (>=4.6.0) - Git hooks for code quality

Troubleshooting
---------------
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '2.1.9',
VERSION: '2.1.10',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/api/datefixer.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Date Utilities &mdash; openseries 2.1.9 documentation</title>
<title>Date Utilities &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=b36c5fd4" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/api/frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>OpenFrame &mdash; openseries 2.1.9 documentation</title>
<title>OpenFrame &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=b36c5fd4" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/api/generated/openseries.OpenFrame.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.OpenFrame &mdash; openseries 2.1.9 documentation</title>
<title>openseries.OpenFrame &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/api/generated/openseries.OpenTimeSeries.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>openseries.OpenTimeSeries &mdash; openseries 2.1.9 documentation</title>
<title>openseries.OpenTimeSeries &mdash; openseries 2.1.10 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=b36c5fd4" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=a7898dfc"></script>
<script src="../../_static/documentation_options.js?v=5f0ef145"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/js/theme.js"></script>
Expand Down
Loading