<img src="https://sales.captor.se/captor_logo_sv_1600_icketransparent.png" alt="Captor
Fund Management AB"
width="81" height="100" align="left" float="right"/><br/>
<br><br>
# OpenSeries
[](https://pypi.org/project/openseries/)
[](https://anaconda.org/conda-forge/openseries)
[](https://anaconda.org/conda-forge/openseries)
[](https://www.python.org/)
[](https://github.com/CaptorAB/OpenSeries/actions/workflows/test.yml)
[](https://github.com/CaptorAB/OpenSeries/actions/workflows/test.yml)
[](https://github.com/CaptorAB/OpenSeries/actions/workflows/check.yml)
[](https://python-poetry.org/)
[](https://beta.ruff.rs/docs/)
[](https://opensource.org/licenses/BSD-3-Clause)
**OpenSeries** is a project with tools to analyse financial timeseries of a single
asset or a group of assets. It is solely made for daily or less frequent data.
<span style="font-size:2em;">[CHANGELOG](https://github.com/CaptorAB/OpenSeries/blob/master/CHANGELOG.md)</span>
## Basic Usage
To install:
```bash
pip install openseries
```
```bash
conda install -c conda-forge openseries
```
An example of how to make use of the OpenTimeSeries is shown below. The design
aligns with how we within our fund company's code base have a subclass of the
OpenTimeSeries with class methods for our different data sources. Combined with some
additional tools it allows us to efficiently present investment cases to clients.
The code snippet can be pasted into a Python console to run it.
Install openseries and yfinance first.
```python
from openseries.series import OpenTimeSeries
import yfinance as yf
msft=yf.Ticker("MSFT")
history=msft.history(period="max")
series=OpenTimeSeries.from_df(history.loc[:, "Close"])
_=series.value_to_log().set_new_label("Microsoft Log Returns of Close Prices")
_,_=series.plot_series()
```
### Sample output using the OpenFrame.all_properties() method:
```
Scilla Global Equity C (simulation+fund) Global Low Volatility index, SEK
ValueType.PRICE ValueType.PRICE
Total return 3.641282 1.946319
Arithmetic return 0.096271 0.069636
Geometric return 0.093057 0.06464
Volatility 0.120279 0.117866
Return vol ratio 0.800396 0.59081
Downside deviation 0.085956 0.086723
Sortino ratio 1.119993 0.802975
Positive share 0.541783 0.551996
Worst -0.071616 -0.089415
Worst month -0.122503 -0.154485
Max drawdown -0.309849 -0.435444
Max drawdown in cal yr -0.309849 -0.348681
Max drawdown dates 2020-03-23 2009-03-09
CVaR 95.0% -0.01793 -0.018429
VaR 95.0% -0.011365 -0.010807
Imp vol from VaR 95% 0.109204 0.103834
Z-score 0.587905 0.103241
Skew -0.650782 -0.888109
Kurtosis 8.511166 17.527367
observations 4309 4309
span of days 6301 6301
first indices 2006-01-03 2006-01-03
last indices 2023-04-05 2023-04-05
```
### Usage example on Jupyter Nbviewer
[](https://nbviewer.org/github/karrmagadgeteer2/NoteBook/blob/master/openseriesnotebook.ipynb)
## Development Instructions
These instructions assume that you have a compatible Python version installed on
your machine and that you are OK to install this project in a virtual environment.
The OpenTimeSeries and OpenFrame classes are both subclasses of
the [Pydantic BaseModel](https://docs.pydantic.dev/usage/models/). Please refer to its documentation for information
on any attributes or methods inherited from this model.
### Windows Powershell
```powershell
git clone https://github.com/CaptorAB/OpenSeries.git
cd OpenSeries
./make.ps1 make
```
### Mac Terminal/Linux
```bash
git clone https://github.com/CaptorAB/OpenSeries.git
cd OpenSeries
make
source source_me
make install
```
## Testing and Linting / Type-checking
Ruff and Mypy checking is embedded in the pre-commit hook. Both
are also used in the project's GitHub workflows and are run when the `lint`
alternative is chosen in the below commands.
Any silenced error codes can be found in the
[pyproject.toml](https://github.com/CaptorAB/OpenSeries/blob/master/pyproject.toml)
file or in in-line comments.
### Windows Powershell
```powershell
./make.ps1 test
./make.ps1 lint
```
### Mac Terminal/Linux
```bash
make test
make lint
```
## Table of Contents
- [Basic Usage](#basic-usage)
- [Development Instructions](#development-instructions)
- [Testing and Linting / Type-checking](#testing-and-linting--type-checking)
- [On some files in the project](#on-some-files-in-the-project)
- [Class methods used to construct an OpenTimeSeries](#class-methods-used-to-construct-objects)
- [OpenTimeSeries non-numerical properties](#non-numerical-or-helper-properties-that-apply-only-to-the-opentimeseries-class)
- [OpenFrame non-numerical properties](#non-numerical-or-helper-properties-that-apply-only-to-the-openframe-class)
- [Non-numerical properties for both classes](#non-numerical-or-helper-properties-that-apply-to-both-the-opentimeseries-and-the-openframe-class)
- [OpenTimeSeries only methods](#methods-that-apply-only-to-the-opentimeseries-class)
- [OpenFrame only methods](#methods-that-apply-only-to-the-openframe-class)
- [Methods for both classes](#methods-that-apply-to-both-the-opentimeseries-and-the-openframe-class)
- [Numerical properties for both classes](#numerical-properties-available-for-individual-opentimeseries-or-on-all-series-in-an-openframe)
- [Numerical methods with period arguments for both classes](#methods-below-are-identical-to-the-numerical-properties-above)
### On some files in the project
| File | Description |
|:-----------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [series.py](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) | Defines the class _OpenTimeSeries_ for managing and analyzing a single timeseries. The module also defines a function `timeseries_chain` that can be used to chain two timeseries objects together. |
| [frame.py](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) | Defines the class _OpenFrame_ for managing a group of timeseries, and e.g. calculate a portfolio timeseries from a rebalancing strategy between timeseries. The module also defines functions to simulate, optimize, and plot portfolios. |
| [simulation.py](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/simulation.py) | Defines the class _ReturnSimulation_ to create simulated financial timeseries. Used in the project's test suite |
### Class methods used to construct objects.
| Method | Applies to | Description |
|:------------------|:------------------------------|:---------------------------------------------------------------------------------------------------|
| `from_arrays` | `OpenTimeSeries` | Class method to create an OpenTimeSeries object from a list of date strings and a list of values. |
| `from_df` | `OpenTimeSeries` | Class method to create an OpenTimeSeries object from a pandas.DataFrame or pandas.Series. |
| `from_fixed_rate` | `OpenTimeSeries` | Class method to create an OpenTimeSeries object from a fixed rate, number of days and an end date. |
| `from_deepcopy` | `OpenTimeSeries`, `OpenFrame` | Creates a copy of an OpenTimeSeries object. |
### Non-numerical or "helper" properties that apply only to the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) class.
| Property | type | Applies to | Description |
|:----------------|:----------------|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------|
| `timeseries_id` | `str` | `OpenTimeSeries` | Placeholder for database identifier for the timeseries. Can be left as empty string. |
| `instrument_id` | `str` | `OpenTimeSeries` | Placeholder for database identifier for the instrument associated with the timeseries. Can be left as empty string. |
| `dates` | `list[str]` | `OpenTimeSeries` | Dates of the timeseries. Not edited by any method to allow reversion to original. |
| `values` | `list[float]` | `OpenTimeSeries` | Values of the timeseries. Not edited by any method to allow reversion to original. |
| `currency` | `str` | `OpenTimeSeries` | Currency of the timeseries. Only used if conversion/hedging methods are added. |
| `domestic` | `str` | `OpenTimeSeries` | Domestic currency of the user / investor. Only used if conversion/hedging methods are added. |
| `local_ccy` | `bool` | `OpenTimeSeries` | Indicates if series should be in its local currency or the domestic currency of the user. Only used if conversion/hedging methods are added. |
| `name` | `str` | `OpenTimeSeries` | An identifier field. |
| `isin` | `str` | `OpenTimeSeries` | ISIN code of the associated instrument. If any. |
| `label` | `str` | `OpenTimeSeries` | Field used in outputs. Derived from name as default. |
| `countries` | `list` or `str` | `OpenTimeSeries` | (List of) country code(s) according to ISO 3166-1 alpha-2 used to generate business days. |
| `valuetype` | `ValueType` | `OpenTimeSeries` | Field identifies the type of values in the series. ValueType is an Enum. |
### Non-numerical or "helper" properties that apply only to the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.
| Property | type | Applies to | Description |
|:-------------------|:-----------------------|:------------|:-------------------------------------------------------------------------|
| `constituents` | `list[OpenTimeSeries]` | `OpenFrame` | A list of the OpenTimeSeries that make up an OpenFrame. |
| `columns_lvl_zero` | `list` | `OpenFrame` | A list of the level zero column names in the OpenFrame pandas.DataFrame. |
| `columns_lvl_one` | `list` | `OpenFrame` | A list of the level one column names in the OpenFrame pandas.DataFrame. |
| `item_count` | `int` | `OpenFrame` | Number of columns in the OpenFrame pandas.DataFrame. |
| `weights` | `list[float]` | `OpenFrame` | Weights used in the method `make_portfolio`. |
| `first_indices` | `pandas.Series` | `OpenFrame` | First dates of all the series in the OpenFrame. |
| `last_indices` | `pandas.Series` | `OpenFrame` | Last dates of all the series in the OpenFrame. |
| `lengths_of_items` | `pandas.Series` | `OpenFrame` | Number of items in each of the series in the OpenFrame. |
| `span_of_days_all` | `pandas.Series` | `OpenFrame` | Number of days from the first to the last in each of the series. |
### Non-numerical or "helper" properties that apply to both the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) and the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.
| Property | type | Applies to | Description |
|:--------------------|:---------------------------------|:------------------------------|:----------------------------------------------------------------------------------|
| `first_idx` | `datetime.date` | `OpenTimeSeries`, `OpenFrame` | First date of the series. |
| `last_idx` | `datetime.date` | `OpenTimeSeries`, `OpenFrame` | Last date of the series. |
| `length` | `int` | `OpenTimeSeries`, `OpenFrame` | Number of items in the series. |
| `span_of_days` | `int` | `OpenTimeSeries`, `OpenFrame` | Number of days from the first to the last date in the series. |
| `tsdf` | `pandas.DataFrame` | `OpenTimeSeries`, `OpenFrame` | The Pandas DataFrame which gets edited by the class methods. |
| `max_drawdown_date` | `datetime.date`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Date when the maximum drawdown occurred. |
| `periods_in_a_year` | `float` | `OpenTimeSeries`, `OpenFrame` | The number of observations in an average year for all days in the data. |
| `yearfrac` | `float` | `OpenTimeSeries`, `OpenFrame` | Length of timeseries expressed as np.float64 fraction of a year with 365.25 days. |
### Methods that apply only to the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) class.
| Method | Applies to | Description |
|:-------------------------|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
| `setup_class` | `OpenTimeSeries` | Class method that defines the `domestic` home currency and the `countries` home countries attributes. |
| `pandas_df` | `OpenTimeSeries` | Method to create the `tsdf` pandas.DataFrame from the `dates` and `values`. |
| `set_new_label` | `OpenTimeSeries` | Method to change the pandas.DataFrame column MultiIndex. |
| `running_adjustment` | `OpenTimeSeries` | Adjusts the series performance with a `float` factor. |
| `ewma_vol_func` | `OpenTimeSeries` | Returns a `pandas.Series` with volatility based on [Exponentially Weighted Moving Average](https://www.investopedia.com/articles/07/ewma.asp). |
| `from_1d_rate_to_cumret` | `OpenTimeSeries` | Converts a series of 1-day rates into a cumulative valueseries. |
|
### Methods that apply only to the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.
| Method | Applies to | Description |
|:------------------------|:------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `merge_series` | `OpenFrame` | Merges the Pandas Dataframes of the constituent OpenTimeSeries. |
| `trunc_frame` | `OpenFrame` | Truncates the OpenFrame to a common period. |
| `add_timeseries` | `OpenFrame` | Adds a given OpenTimeSeries to the OpenFrame. |
| `delete_timeseries` | `OpenFrame` | Deletes an OpenTimeSeries from the OpenFrame. |
| `relative` | `OpenFrame` | Calculates a new series that is the relative performance of two others. |
| `make_portfolio` | `OpenFrame` | Calculates a portfolio timeseries based on the series and weights. Weights can be provided as a list, or a weight strategy can be set as *equal weights* or *inverted volatility*. |
| `ord_least_squares_fit` | `OpenFrame` | Performs a regression and an [Ordinary Least Squares](https://www.statsmodels.org/stable/examples/notebooks/generated/ols.html) fit. |
| `beta` | `OpenFrame` | Calculates [Beta](https://www.investopedia.com/terms/b/beta.asp) of an asset relative a market. |
| `jensen_alpha` | `OpenFrame` | Calculates [Jensen's Alpha](https://www.investopedia.com/terms/j/jensensmeasure.asp) of an asset relative a market. |
| `tracking_error_func` | `OpenFrame` | Calculates the [tracking errors](https://www.investopedia.com/terms/t/trackingerror.asp) relative to a selected series in the OpenFrame. |
| `info_ratio_func` | `OpenFrame` | Calculates the [information ratios](https://www.investopedia.com/terms/i/informationratio.asp) relative to a selected series in the OpenFrame. |
| `capture_ratio_func` | `OpenFrame` | Calculates up, down and up/down [capture ratios](https://www.investopedia.com/terms/d/down-market-capture-ratio.asp) relative to a selected series. |
| `rolling_info_ratio` | `OpenFrame` | Returns a pandas.DataFrame with the rolling [information ratio](https://www.investopedia.com/terms/i/informationratio.asp) between two series. |
| `rolling_beta` | `OpenFrame` | Returns a pandas.DataFrame with the rolling [Beta](https://www.investopedia.com/terms/b/beta.asp) of an asset relative a market. |
| `rolling_corr` | `OpenFrame` | Calculates and adds a series of rolling [correlations](https://www.investopedia.com/terms/c/correlation.asp) between two other series. |
| `ewma_risk` | `OpenFrame` | Returns a `pandas.DataFrame` with volatility and correlation based on [Exponentially Weighted Moving Average](https://www.investopedia.com/articles/07/ewma.asp). |
### Methods that apply to both the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) and the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.
| Method | Applies to | Description |
|:-----------------------------------|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `align_index_to_local_cdays` | `OpenTimeSeries`, `OpenFrame` | Aligns the series dates to a business calendar. Defaults to Sweden. |
| `resample` | `OpenTimeSeries`, `OpenFrame` | Resamples the series to a specific frequency. |
| `resample_to_business_period_ends` | `OpenTimeSeries`, `OpenFrame` | Resamples the series to month-end dates with monthly, quarterly or annual frequency. |
| `value_nan_handle` | `OpenTimeSeries`, `OpenFrame` | Fills `Nan` in a value series with the preceding non-Nan value. |
| `return_nan_handle` | `OpenTimeSeries`, `OpenFrame` | Replaces `Nan` in a return series with a 0.0 `float`. |
| `to_cumret` | `OpenTimeSeries`, `OpenFrame` | Converts a return series into a value series and/or resets a value series to be rebased from 1.0. |
| `to_json` | `OpenTimeSeries`, `OpenFrame` | Method to export the raw unaltered data to a json file. |
| `to_xlsx` | `OpenTimeSeries`, `OpenFrame` | Method to save the data in the .tsdf DataFrame to an Excel file. |
| `value_to_ret` | `OpenTimeSeries`, `OpenFrame` | Converts a value series into a percentage return series. |
| `value_to_diff` | `OpenTimeSeries`, `OpenFrame` | Converts a value series into a series of differences. |
| `value_to_log` | `OpenTimeSeries`, `OpenFrame` | Converts a value series into a logarithmic return series. |
| `value_ret_calendar_period` | `OpenTimeSeries`, `OpenFrame` | Returns the series simple return for a specific calendar period. |
| `plot_series` | `OpenTimeSeries`, `OpenFrame` | Opens a HTML [Plotly Scatter](https://plotly.com/python/line-and-scatter/) plot of the series in a browser window. |
| `plot_bars` | `OpenTimeSeries`, `OpenFrame` | Opens a HTML [Plotly Bar](https://plotly.com/python/bar-charts/) plot of the series in a browser window. |
| `to_drawdown_series` | `OpenTimeSeries`, `OpenFrame` | Converts the series into drawdown series. |
| `rolling_return` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling returns. |
| `rolling_vol` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling volatilities. |
| `rolling_var_down` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling VaR figures. |
| `rolling_cvar_down` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling CVaR figures. |
| `calc_range` | `OpenTimeSeries`, `OpenFrame` | Returns the start and end dates of a range from specific period definitions. Used by the below numerical methods and not meant to be used independently. |
### Numerical properties available for individual [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) or on all series in an [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py).
| Property | type | Applies to | Description |
|:------------------------|:-------------------------|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `all_properties` | `pandas.DataFrame` | `OpenTimeSeries`, `OpenFrame` | Returns most of the properties in one go. |
| `arithmetic_ret` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Annualized arithmetic mean of returns](https://www.investopedia.com/terms/a/arithmeticmean.asp). |
| `geo_ret` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Compound Annual Growth Rate(CAGR)](https://www.investopedia.com/terms/c/cagr.asp), a specific implementation of geometric mean. |
| `value_ret` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Simple return from first to last observation. |
| `vol` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Annualized [volatility](https://www.investopedia.com/terms/v/volatility.asp). Pandas .std() is the equivalent of stdev.s([...]) in MS excel. |
| `downside_deviation` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Downside deviation](https://www.investopedia.com/terms/d/downside-deviation.asp) is the volatility of all negative return observations. Minimum Accepted Return (MAR) set to zero. |
| `ret_vol_ratio` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Ratio of arithmetic mean return and annualized volatility. It is the [Sharpe Ratio](https://www.investopedia.com/terms/s/sharperatio.asp) with the riskfree rate set to zero. |
| `sortino_ratio` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The [Sortino Ratio](https://www.investopedia.com/terms/s/sortinoratio.asp) is the arithmetic mean return divided by the downside deviation. This attribute assumes that the riskfree rate and the MAR are both zero. |
| `var_down` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Value At Risk](https://www.investopedia.com/terms/v/var.asp), "VaR". The equivalent of percentile.inc([...], 1-level) over returns in MS Excel. For other confidence levels use the corresponding method. |
| `cvar_down` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Conditional Value At Risk](https://www.investopedia.com/terms/c/conditional_value_at_risk.asp), "CVaR". For other confidence levels use the corresponding method. |
| `worst` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Most negative percentage change of a single observation. |
| `worst_month` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Most negative month. |
| `max_drawdown` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Maximum drawdown](https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp). |
| `max_drawdown_cal_year` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Max drawdown in a single calendar year. |
| `positive_share` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The share of percentage changes that are positive. |
| `vol_from_var` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Implied annualized volatility from the Downside VaR using the assumption that returns are normally distributed. |
| `skew` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Skew](https://www.investopedia.com/terms/s/skewness.asp) of the return distribution. |
| `kurtosis` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Kurtosis](https://www.investopedia.com/terms/k/kurtosis.asp) of the return distribution. |
| `z_score` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Z-score](https://www.investopedia.com/terms/z/zscore.asp) as (last return - mean return) / standard deviation of returns. |
| `correl_matrix` | `pandas.DataFrame` | `OpenFrame` | A correlation matrix. |
### Methods below are identical to the Numerical Properties above.
_They are simply methods that take different date or length inputs to return the
properties for subset periods._
| Method | type | Applies to | Description |
|:--------------------------|:-------------------------|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `arithmetic_ret_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Annualized arithmetic mean of returns](https://www.investopedia.com/terms/a/arithmeticmean.asp). |
| `geo_ret_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Compound Annual Growth Rate(CAGR)](https://www.investopedia.com/terms/c/cagr.asp), a specific implementation of geometric mean. |
| `value_ret_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Simple return from first to last observation. |
| `vol_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Annualized [volatility](https://www.investopedia.com/terms/v/volatility.asp). Pandas .std() is the equivalent of stdev.s([...]) in MS excel. |
| `downside_deviation_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Downside deviation](https://www.investopedia.com/terms/d/downside-deviation.asp) is the volatility of all negative return observations. MAR and riskfree rate can be set. |
| `ret_vol_ratio_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Ratio of arithmetic mean return and annualized volatility. It is the [Sharpe Ratio](https://www.investopedia.com/terms/s/sharperatio.asp) with the riskfree rate set to zero. A riskfree rate can be set as a float or a series chosen for the frame function. |
| `sortino_ratio_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The [Sortino Ratio](https://www.investopedia.com/terms/s/sortinoratio.asp) is the arithmetic mean return divided by the downside deviation. A riskfree rate can be set as a float or a series chosen for the frame function. MAR is set to zero. |
| `var_down_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Value At Risk](https://www.investopedia.com/terms/v/var.asp), "VaR". The equivalent of percentile.inc([...], 1-level) over returns in MS Excel. Default is 95% confidence level. |
| `cvar_down_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Conditional Value At Risk](https://www.investopedia.com/terms/c/conditional_value_at_risk.asp), "CVaR". Default is 95% confidence level. |
| `worst_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Most negative percentage change for a given number of observations (default=1). |
| `max_drawdown_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Maximum drawdown](https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp). |
| `positive_share_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The share of percentage changes that are positive. |
| `vol_from_var_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Implied annualized volatility from the Downside VaR using the assumption that returns are normally distributed. |
| `skew_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Skew](https://www.investopedia.com/terms/s/skewness.asp) of the return distribution. |
| `kurtosis_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Kurtosis](https://www.investopedia.com/terms/k/kurtosis.asp) of the return distribution. |
| `z_score_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Z-score](https://www.investopedia.com/terms/z/zscore.asp) as (last return - mean return) / standard deviation of returns. |
| `target_weight_from_var` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | A position target weight from the ratio between a VaR implied volatility and a given target volatility. |
Raw data
{
"_id": null,
"home_page": "https://github.com/CaptorAB/OpenSeries",
"name": "openseries",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "python, finance, fintech, data-science, timeseries, timeseries-data, timeseries-analysis, investment, investment-analysis, investing",
"author": "Martin Karrin",
"author_email": "martin.karrin@captor.se",
"download_url": "https://files.pythonhosted.org/packages/62/f2/c87f61886f4a30a8a4f39ef34288c6654a01d2a0b06104bc1e82db0eaaf1/openseries-1.5.1.tar.gz",
"platform": null,
"description": "<img src=\"https://sales.captor.se/captor_logo_sv_1600_icketransparent.png\" alt=\"Captor\nFund Management AB\"\nwidth=\"81\" height=\"100\" align=\"left\" float=\"right\"/><br/>\n\n<br><br>\n\n# OpenSeries\n\n[](https://pypi.org/project/openseries/)\n[](https://anaconda.org/conda-forge/openseries)\n[](https://anaconda.org/conda-forge/openseries)\n[](https://www.python.org/)\n[](https://github.com/CaptorAB/OpenSeries/actions/workflows/test.yml)\n[](https://github.com/CaptorAB/OpenSeries/actions/workflows/test.yml)\n[](https://github.com/CaptorAB/OpenSeries/actions/workflows/check.yml)\n[](https://python-poetry.org/)\n[](https://beta.ruff.rs/docs/)\n[](https://opensource.org/licenses/BSD-3-Clause)\n\n**OpenSeries** is a project with tools to analyse financial timeseries of a single\nasset or a group of assets. It is solely made for daily or less frequent data.\n\n<span style=\"font-size:2em;\">[CHANGELOG](https://github.com/CaptorAB/OpenSeries/blob/master/CHANGELOG.md)</span>\n\n\n## Basic Usage\n\nTo install:\n\n```bash\npip install openseries\n```\n\n```bash\nconda install -c conda-forge openseries\n```\n\nAn example of how to make use of the OpenTimeSeries is shown below. The design\naligns with how we within our fund company's code base have a subclass of the\nOpenTimeSeries with class methods for our different data sources. Combined with some\nadditional tools it allows us to efficiently present investment cases to clients.\n\nThe code snippet can be pasted into a Python console to run it.\nInstall openseries and yfinance first.\n\n```python\nfrom openseries.series import OpenTimeSeries\nimport yfinance as yf\n\nmsft=yf.Ticker(\"MSFT\")\nhistory=msft.history(period=\"max\")\nseries=OpenTimeSeries.from_df(history.loc[:, \"Close\"])\n_=series.value_to_log().set_new_label(\"Microsoft Log Returns of Close Prices\")\n_,_=series.plot_series()\n\n```\n\n### Sample output using the OpenFrame.all_properties() method:\n```\n Scilla Global Equity C (simulation+fund) Global Low Volatility index, SEK\n ValueType.PRICE ValueType.PRICE\nTotal return 3.641282 1.946319\nArithmetic return 0.096271 0.069636\nGeometric return 0.093057 0.06464\nVolatility 0.120279 0.117866\nReturn vol ratio 0.800396 0.59081\nDownside deviation 0.085956 0.086723\nSortino ratio 1.119993 0.802975\nPositive share 0.541783 0.551996\nWorst -0.071616 -0.089415\nWorst month -0.122503 -0.154485\nMax drawdown -0.309849 -0.435444\nMax drawdown in cal yr -0.309849 -0.348681\nMax drawdown dates 2020-03-23 2009-03-09\nCVaR 95.0% -0.01793 -0.018429\nVaR 95.0% -0.011365 -0.010807\nImp vol from VaR 95% 0.109204 0.103834\nZ-score 0.587905 0.103241\nSkew -0.650782 -0.888109\nKurtosis 8.511166 17.527367\nobservations 4309 4309\nspan of days 6301 6301\nfirst indices 2006-01-03 2006-01-03\nlast indices 2023-04-05 2023-04-05\n```\n\n### Usage example on Jupyter Nbviewer\n\n[](https://nbviewer.org/github/karrmagadgeteer2/NoteBook/blob/master/openseriesnotebook.ipynb)\n\n\n## Development Instructions\n\nThese instructions assume that you have a compatible Python version installed on\nyour machine and that you are OK to install this project in a virtual environment.\n\nThe OpenTimeSeries and OpenFrame classes are both subclasses of\nthe [Pydantic BaseModel](https://docs.pydantic.dev/usage/models/). Please refer to its documentation for information\non any attributes or methods inherited from this model.\n\n\n### Windows Powershell\n\n```powershell\ngit clone https://github.com/CaptorAB/OpenSeries.git\ncd OpenSeries\n./make.ps1 make\n\n```\n\n### Mac Terminal/Linux\n\n```bash\ngit clone https://github.com/CaptorAB/OpenSeries.git\ncd OpenSeries\nmake\nsource source_me\nmake install\n\n```\n\n## Testing and Linting / Type-checking\n\nRuff and Mypy checking is embedded in the pre-commit hook. Both\nare also used in the project's GitHub workflows and are run when the `lint`\nalternative is chosen in the below commands.\nAny silenced error codes can be found in the\n[pyproject.toml](https://github.com/CaptorAB/OpenSeries/blob/master/pyproject.toml)\nfile or in in-line comments.\n\n### Windows Powershell\n\n```powershell\n./make.ps1 test\n./make.ps1 lint\n\n```\n\n### Mac Terminal/Linux\n\n```bash\nmake test\nmake lint\n\n```\n\n\n## Table of Contents\n\n- [Basic Usage](#basic-usage)\n- [Development Instructions](#development-instructions)\n- [Testing and Linting / Type-checking](#testing-and-linting--type-checking)\n- [On some files in the project](#on-some-files-in-the-project)\n- [Class methods used to construct an OpenTimeSeries](#class-methods-used-to-construct-objects)\n- [OpenTimeSeries non-numerical properties](#non-numerical-or-helper-properties-that-apply-only-to-the-opentimeseries-class)\n- [OpenFrame non-numerical properties](#non-numerical-or-helper-properties-that-apply-only-to-the-openframe-class)\n- [Non-numerical properties for both classes](#non-numerical-or-helper-properties-that-apply-to-both-the-opentimeseries-and-the-openframe-class)\n- [OpenTimeSeries only methods](#methods-that-apply-only-to-the-opentimeseries-class)\n- [OpenFrame only methods](#methods-that-apply-only-to-the-openframe-class)\n- [Methods for both classes](#methods-that-apply-to-both-the-opentimeseries-and-the-openframe-class)\n- [Numerical properties for both classes](#numerical-properties-available-for-individual-opentimeseries-or-on-all-series-in-an-openframe)\n- [Numerical methods with period arguments for both classes](#methods-below-are-identical-to-the-numerical-properties-above)\n\n### On some files in the project\n\n| File | Description |\n|:-----------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [series.py](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) | Defines the class _OpenTimeSeries_ for managing and analyzing a single timeseries. The module also defines a function `timeseries_chain` that can be used to chain two timeseries objects together. |\n| [frame.py](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) | Defines the class _OpenFrame_ for managing a group of timeseries, and e.g. calculate a portfolio timeseries from a rebalancing strategy between timeseries. The module also defines functions to simulate, optimize, and plot portfolios. |\n| [simulation.py](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/simulation.py) | Defines the class _ReturnSimulation_ to create simulated financial timeseries. Used in the project's test suite |\n\n### Class methods used to construct objects.\n\n| Method | Applies to | Description |\n|:------------------|:------------------------------|:---------------------------------------------------------------------------------------------------|\n| `from_arrays` | `OpenTimeSeries` | Class method to create an OpenTimeSeries object from a list of date strings and a list of values. |\n| `from_df` | `OpenTimeSeries` | Class method to create an OpenTimeSeries object from a pandas.DataFrame or pandas.Series. |\n| `from_fixed_rate` | `OpenTimeSeries` | Class method to create an OpenTimeSeries object from a fixed rate, number of days and an end date. |\n| `from_deepcopy` | `OpenTimeSeries`, `OpenFrame` | Creates a copy of an OpenTimeSeries object. |\n\n### Non-numerical or \"helper\" properties that apply only to the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) class.\n\n| Property | type | Applies to | Description |\n|:----------------|:----------------|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------|\n| `timeseries_id` | `str` | `OpenTimeSeries` | Placeholder for database identifier for the timeseries. Can be left as empty string. |\n| `instrument_id` | `str` | `OpenTimeSeries` | Placeholder for database identifier for the instrument associated with the timeseries. Can be left as empty string. |\n| `dates` | `list[str]` | `OpenTimeSeries` | Dates of the timeseries. Not edited by any method to allow reversion to original. |\n| `values` | `list[float]` | `OpenTimeSeries` | Values of the timeseries. Not edited by any method to allow reversion to original. |\n| `currency` | `str` | `OpenTimeSeries` | Currency of the timeseries. Only used if conversion/hedging methods are added. |\n| `domestic` | `str` | `OpenTimeSeries` | Domestic currency of the user / investor. Only used if conversion/hedging methods are added. |\n| `local_ccy` | `bool` | `OpenTimeSeries` | Indicates if series should be in its local currency or the domestic currency of the user. Only used if conversion/hedging methods are added. |\n| `name` | `str` | `OpenTimeSeries` | An identifier field. |\n| `isin` | `str` | `OpenTimeSeries` | ISIN code of the associated instrument. If any. |\n| `label` | `str` | `OpenTimeSeries` | Field used in outputs. Derived from name as default. |\n| `countries` | `list` or `str` | `OpenTimeSeries` | (List of) country code(s) according to ISO 3166-1 alpha-2 used to generate business days. |\n| `valuetype` | `ValueType` | `OpenTimeSeries` | Field identifies the type of values in the series. ValueType is an Enum. |\n\n### Non-numerical or \"helper\" properties that apply only to the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.\n\n| Property | type | Applies to | Description |\n|:-------------------|:-----------------------|:------------|:-------------------------------------------------------------------------|\n| `constituents` | `list[OpenTimeSeries]` | `OpenFrame` | A list of the OpenTimeSeries that make up an OpenFrame. |\n| `columns_lvl_zero` | `list` | `OpenFrame` | A list of the level zero column names in the OpenFrame pandas.DataFrame. |\n| `columns_lvl_one` | `list` | `OpenFrame` | A list of the level one column names in the OpenFrame pandas.DataFrame. |\n| `item_count` | `int` | `OpenFrame` | Number of columns in the OpenFrame pandas.DataFrame. |\n| `weights` | `list[float]` | `OpenFrame` | Weights used in the method `make_portfolio`. |\n| `first_indices` | `pandas.Series` | `OpenFrame` | First dates of all the series in the OpenFrame. |\n| `last_indices` | `pandas.Series` | `OpenFrame` | Last dates of all the series in the OpenFrame. |\n| `lengths_of_items` | `pandas.Series` | `OpenFrame` | Number of items in each of the series in the OpenFrame. |\n| `span_of_days_all` | `pandas.Series` | `OpenFrame` | Number of days from the first to the last in each of the series. |\n\n### Non-numerical or \"helper\" properties that apply to both the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) and the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.\n\n| Property | type | Applies to | Description |\n|:--------------------|:---------------------------------|:------------------------------|:----------------------------------------------------------------------------------|\n| `first_idx` | `datetime.date` | `OpenTimeSeries`, `OpenFrame` | First date of the series. |\n| `last_idx` | `datetime.date` | `OpenTimeSeries`, `OpenFrame` | Last date of the series. |\n| `length` | `int` | `OpenTimeSeries`, `OpenFrame` | Number of items in the series. |\n| `span_of_days` | `int` | `OpenTimeSeries`, `OpenFrame` | Number of days from the first to the last date in the series. |\n| `tsdf` | `pandas.DataFrame` | `OpenTimeSeries`, `OpenFrame` | The Pandas DataFrame which gets edited by the class methods. |\n| `max_drawdown_date` | `datetime.date`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Date when the maximum drawdown occurred. |\n| `periods_in_a_year` | `float` | `OpenTimeSeries`, `OpenFrame` | The number of observations in an average year for all days in the data. |\n| `yearfrac` | `float` | `OpenTimeSeries`, `OpenFrame` | Length of timeseries expressed as np.float64 fraction of a year with 365.25 days. |\n\n### Methods that apply only to the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) class.\n\n| Method | Applies to | Description |\n|:-------------------------|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `setup_class` | `OpenTimeSeries` | Class method that defines the `domestic` home currency and the `countries` home countries attributes. |\n| `pandas_df` | `OpenTimeSeries` | Method to create the `tsdf` pandas.DataFrame from the `dates` and `values`. |\n| `set_new_label` | `OpenTimeSeries` | Method to change the pandas.DataFrame column MultiIndex. |\n| `running_adjustment` | `OpenTimeSeries` | Adjusts the series performance with a `float` factor. |\n| `ewma_vol_func` | `OpenTimeSeries` | Returns a `pandas.Series` with volatility based on [Exponentially Weighted Moving Average](https://www.investopedia.com/articles/07/ewma.asp). |\n| `from_1d_rate_to_cumret` | `OpenTimeSeries` | Converts a series of 1-day rates into a cumulative valueseries. |\n |\n\n### Methods that apply only to the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.\n\n| Method | Applies to | Description |\n|:------------------------|:------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `merge_series` | `OpenFrame` | Merges the Pandas Dataframes of the constituent OpenTimeSeries. |\n| `trunc_frame` | `OpenFrame` | Truncates the OpenFrame to a common period. |\n| `add_timeseries` | `OpenFrame` | Adds a given OpenTimeSeries to the OpenFrame. |\n| `delete_timeseries` | `OpenFrame` | Deletes an OpenTimeSeries from the OpenFrame. |\n| `relative` | `OpenFrame` | Calculates a new series that is the relative performance of two others. |\n| `make_portfolio` | `OpenFrame` | Calculates a portfolio timeseries based on the series and weights. Weights can be provided as a list, or a weight strategy can be set as *equal weights* or *inverted volatility*. |\n| `ord_least_squares_fit` | `OpenFrame` | Performs a regression and an [Ordinary Least Squares](https://www.statsmodels.org/stable/examples/notebooks/generated/ols.html) fit. |\n| `beta` | `OpenFrame` | Calculates [Beta](https://www.investopedia.com/terms/b/beta.asp) of an asset relative a market. |\n| `jensen_alpha` | `OpenFrame` | Calculates [Jensen's Alpha](https://www.investopedia.com/terms/j/jensensmeasure.asp) of an asset relative a market. |\n| `tracking_error_func` | `OpenFrame` | Calculates the [tracking errors](https://www.investopedia.com/terms/t/trackingerror.asp) relative to a selected series in the OpenFrame. |\n| `info_ratio_func` | `OpenFrame` | Calculates the [information ratios](https://www.investopedia.com/terms/i/informationratio.asp) relative to a selected series in the OpenFrame. |\n| `capture_ratio_func` | `OpenFrame` | Calculates up, down and up/down [capture ratios](https://www.investopedia.com/terms/d/down-market-capture-ratio.asp) relative to a selected series. |\n| `rolling_info_ratio` | `OpenFrame` | Returns a pandas.DataFrame with the rolling [information ratio](https://www.investopedia.com/terms/i/informationratio.asp) between two series. |\n| `rolling_beta` | `OpenFrame` | Returns a pandas.DataFrame with the rolling [Beta](https://www.investopedia.com/terms/b/beta.asp) of an asset relative a market. |\n| `rolling_corr` | `OpenFrame` | Calculates and adds a series of rolling [correlations](https://www.investopedia.com/terms/c/correlation.asp) between two other series. |\n| `ewma_risk` | `OpenFrame` | Returns a `pandas.DataFrame` with volatility and correlation based on [Exponentially Weighted Moving Average](https://www.investopedia.com/articles/07/ewma.asp). |\n\n### Methods that apply to both the [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) and the [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py) class.\n\n| Method | Applies to | Description |\n|:-----------------------------------|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `align_index_to_local_cdays` | `OpenTimeSeries`, `OpenFrame` | Aligns the series dates to a business calendar. Defaults to Sweden. |\n| `resample` | `OpenTimeSeries`, `OpenFrame` | Resamples the series to a specific frequency. |\n| `resample_to_business_period_ends` | `OpenTimeSeries`, `OpenFrame` | Resamples the series to month-end dates with monthly, quarterly or annual frequency. |\n| `value_nan_handle` | `OpenTimeSeries`, `OpenFrame` | Fills `Nan` in a value series with the preceding non-Nan value. |\n| `return_nan_handle` | `OpenTimeSeries`, `OpenFrame` | Replaces `Nan` in a return series with a 0.0 `float`. |\n| `to_cumret` | `OpenTimeSeries`, `OpenFrame` | Converts a return series into a value series and/or resets a value series to be rebased from 1.0. |\n| `to_json` | `OpenTimeSeries`, `OpenFrame` | Method to export the raw unaltered data to a json file. |\n| `to_xlsx` | `OpenTimeSeries`, `OpenFrame` | Method to save the data in the .tsdf DataFrame to an Excel file. |\n| `value_to_ret` | `OpenTimeSeries`, `OpenFrame` | Converts a value series into a percentage return series. |\n| `value_to_diff` | `OpenTimeSeries`, `OpenFrame` | Converts a value series into a series of differences. |\n| `value_to_log` | `OpenTimeSeries`, `OpenFrame` | Converts a value series into a logarithmic return series. |\n| `value_ret_calendar_period` | `OpenTimeSeries`, `OpenFrame` | Returns the series simple return for a specific calendar period. |\n| `plot_series` | `OpenTimeSeries`, `OpenFrame` | Opens a HTML [Plotly Scatter](https://plotly.com/python/line-and-scatter/) plot of the series in a browser window. |\n| `plot_bars` | `OpenTimeSeries`, `OpenFrame` | Opens a HTML [Plotly Bar](https://plotly.com/python/bar-charts/) plot of the series in a browser window. |\n| `to_drawdown_series` | `OpenTimeSeries`, `OpenFrame` | Converts the series into drawdown series. |\n| `rolling_return` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling returns. |\n| `rolling_vol` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling volatilities. |\n| `rolling_var_down` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling VaR figures. |\n| `rolling_cvar_down` | `OpenTimeSeries`, `OpenFrame` | Returns a pandas.DataFrame with rolling CVaR figures. |\n| `calc_range` | `OpenTimeSeries`, `OpenFrame` | Returns the start and end dates of a range from specific period definitions. Used by the below numerical methods and not meant to be used independently. |\n\n### Numerical properties available for individual [OpenTimeSeries](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/series.py) or on all series in an [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/frame.py).\n\n| Property | type | Applies to | Description |\n|:------------------------|:-------------------------|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `all_properties` | `pandas.DataFrame` | `OpenTimeSeries`, `OpenFrame` | Returns most of the properties in one go. |\n| `arithmetic_ret` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Annualized arithmetic mean of returns](https://www.investopedia.com/terms/a/arithmeticmean.asp). |\n| `geo_ret` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Compound Annual Growth Rate(CAGR)](https://www.investopedia.com/terms/c/cagr.asp), a specific implementation of geometric mean. |\n| `value_ret` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Simple return from first to last observation. |\n| `vol` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Annualized [volatility](https://www.investopedia.com/terms/v/volatility.asp). Pandas .std() is the equivalent of stdev.s([...]) in MS excel. |\n| `downside_deviation` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Downside deviation](https://www.investopedia.com/terms/d/downside-deviation.asp) is the volatility of all negative return observations. Minimum Accepted Return (MAR) set to zero. |\n| `ret_vol_ratio` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Ratio of arithmetic mean return and annualized volatility. It is the [Sharpe Ratio](https://www.investopedia.com/terms/s/sharperatio.asp) with the riskfree rate set to zero. |\n| `sortino_ratio` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The [Sortino Ratio](https://www.investopedia.com/terms/s/sortinoratio.asp) is the arithmetic mean return divided by the downside deviation. This attribute assumes that the riskfree rate and the MAR are both zero. |\n| `var_down` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Value At Risk](https://www.investopedia.com/terms/v/var.asp), \"VaR\". The equivalent of percentile.inc([...], 1-level) over returns in MS Excel. For other confidence levels use the corresponding method. |\n| `cvar_down` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Conditional Value At Risk](https://www.investopedia.com/terms/c/conditional_value_at_risk.asp), \"CVaR\". For other confidence levels use the corresponding method. |\n| `worst` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Most negative percentage change of a single observation. |\n| `worst_month` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Most negative month. |\n| `max_drawdown` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Maximum drawdown](https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp). |\n| `max_drawdown_cal_year` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Max drawdown in a single calendar year. |\n| `positive_share` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The share of percentage changes that are positive. |\n| `vol_from_var` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Implied annualized volatility from the Downside VaR using the assumption that returns are normally distributed. |\n| `skew` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Skew](https://www.investopedia.com/terms/s/skewness.asp) of the return distribution. |\n| `kurtosis` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Kurtosis](https://www.investopedia.com/terms/k/kurtosis.asp) of the return distribution. |\n| `z_score` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Z-score](https://www.investopedia.com/terms/z/zscore.asp) as (last return - mean return) / standard deviation of returns. |\n| `correl_matrix` | `pandas.DataFrame` | `OpenFrame` | A correlation matrix. |\n\n### Methods below are identical to the Numerical Properties above.\n\n_They are simply methods that take different date or length inputs to return the\nproperties for subset periods._\n\n| Method | type | Applies to | Description |\n|:--------------------------|:-------------------------|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `arithmetic_ret_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Annualized arithmetic mean of returns](https://www.investopedia.com/terms/a/arithmeticmean.asp). |\n| `geo_ret_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Compound Annual Growth Rate(CAGR)](https://www.investopedia.com/terms/c/cagr.asp), a specific implementation of geometric mean. |\n| `value_ret_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Simple return from first to last observation. |\n| `vol_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Annualized [volatility](https://www.investopedia.com/terms/v/volatility.asp). Pandas .std() is the equivalent of stdev.s([...]) in MS excel. |\n| `downside_deviation_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Downside deviation](https://www.investopedia.com/terms/d/downside-deviation.asp) is the volatility of all negative return observations. MAR and riskfree rate can be set. |\n| `ret_vol_ratio_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Ratio of arithmetic mean return and annualized volatility. It is the [Sharpe Ratio](https://www.investopedia.com/terms/s/sharperatio.asp) with the riskfree rate set to zero. A riskfree rate can be set as a float or a series chosen for the frame function. |\n| `sortino_ratio_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The [Sortino Ratio](https://www.investopedia.com/terms/s/sortinoratio.asp) is the arithmetic mean return divided by the downside deviation. A riskfree rate can be set as a float or a series chosen for the frame function. MAR is set to zero. |\n| `var_down_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Value At Risk](https://www.investopedia.com/terms/v/var.asp), \"VaR\". The equivalent of percentile.inc([...], 1-level) over returns in MS Excel. Default is 95% confidence level. |\n| `cvar_down_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Downside 95% [Conditional Value At Risk](https://www.investopedia.com/terms/c/conditional_value_at_risk.asp), \"CVaR\". Default is 95% confidence level. |\n| `worst_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Most negative percentage change for a given number of observations (default=1). |\n| `max_drawdown_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Maximum drawdown](https://www.investopedia.com/terms/m/maximum-drawdown-mdd.asp). |\n| `positive_share_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | The share of percentage changes that are positive. |\n| `vol_from_var_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | Implied annualized volatility from the Downside VaR using the assumption that returns are normally distributed. |\n| `skew_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Skew](https://www.investopedia.com/terms/s/skewness.asp) of the return distribution. |\n| `kurtosis_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Kurtosis](https://www.investopedia.com/terms/k/kurtosis.asp) of the return distribution. |\n| `z_score_func` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | [Z-score](https://www.investopedia.com/terms/z/zscore.asp) as (last return - mean return) / standard deviation of returns. |\n| `target_weight_from_var` | `float`, `pandas.Series` | `OpenTimeSeries`, `OpenFrame` | A position target weight from the ratio between a VaR implied volatility and a given target volatility. |\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Package for analyzing financial timeseries.",
"version": "1.5.1",
"project_urls": {
"Homepage": "https://github.com/CaptorAB/OpenSeries",
"Repository": "https://github.com/CaptorAB/OpenSeries"
},
"split_keywords": [
"python",
" finance",
" fintech",
" data-science",
" timeseries",
" timeseries-data",
" timeseries-analysis",
" investment",
" investment-analysis",
" investing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ae8eef053405dcfaac5478b90f450eb4538ca3df35aeab4aebc099840c6c77f8",
"md5": "1ff83349c8cafd1633ee69f09681982a",
"sha256": "45c6a97dd58ec0bae3db23b92482c852f9029c3f5c1b1255aacde0344ed922a3"
},
"downloads": -1,
"filename": "openseries-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ff83349c8cafd1633ee69f09681982a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 50530,
"upload_time": "2024-03-30T15:12:01",
"upload_time_iso_8601": "2024-03-30T15:12:01.809438Z",
"url": "https://files.pythonhosted.org/packages/ae/8e/ef053405dcfaac5478b90f450eb4538ca3df35aeab4aebc099840c6c77f8/openseries-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "62f2c87f61886f4a30a8a4f39ef34288c6654a01d2a0b06104bc1e82db0eaaf1",
"md5": "18fc629be035d8b62bd7a54d5169bd9c",
"sha256": "60226c48724abbf2a81fdaa5c5526dd105cfd3669121e275a1ba3c282fefef19"
},
"downloads": -1,
"filename": "openseries-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "18fc629be035d8b62bd7a54d5169bd9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 52982,
"upload_time": "2024-03-30T15:12:05",
"upload_time_iso_8601": "2024-03-30T15:12:05.630508Z",
"url": "https://files.pythonhosted.org/packages/62/f2/c87f61886f4a30a8a4f39ef34288c6654a01d2a0b06104bc1e82db0eaaf1/openseries-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 15:12:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CaptorAB",
"github_project": "OpenSeries",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openseries"
}
JSON
