Skip to main content

Sharpe ratio

Project description

📦 jsharpe

PyPI version License: MIT CI Created with qCradle

Open in GitHub Codespaces

🚀 Getting Started

🔧 Set Up Environment

make install

This installs/updates uv, creates your virtual environment and installs dependencies.

For adding or removing packages:

uv add/remove requests  # for main dependencies
uv add/remove requests --dev  # for dev dependencies

✅ Configure Pre-commit Hooks

make fmt

Installs hooks to maintain code quality and formatting.

🛠️ Development Commands

make tests   # Run test suite
make marimo  # Start Marimo notebooks

👥 Contributing

  • 🍴 Fork the repository
  • 🌿 Create your feature branch (git checkout -b feature/amazing-feature)
  • 💾 Commit your changes (git commit -m 'Add some amazing feature')
  • 🚢 Push to the branch (git push origin feature/amazing-feature)
  • 🔍 Open a Pull Request

📚 Usage

Run this minimal, deterministic example to compute the Probabilistic Sharpe Ratio (PSR) from the package functions.

from jsharpe import probabilistic_sharpe_ratio

sr = 0.036 / 0.079
psr = probabilistic_sharpe_ratio(SR=sr, SR0=0, T=24, gamma3=-2.448, gamma4=10.164)
print(f"{psr:.3f}")
0.987

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsharpe-0.0.1.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jsharpe-0.0.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file jsharpe-0.0.1.tar.gz.

File metadata

  • Download URL: jsharpe-0.0.1.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jsharpe-0.0.1.tar.gz
Algorithm Hash digest
SHA256 1f6733e39e89ebaf0a5c474633d88ae194e56ed15d84f6c92eea0063672c0fe6
MD5 13281c5ac719e6879b1712edf437c6da
BLAKE2b-256 aabc13beced7ad6100bc077e47a8b154fc36c3859b6dc5257c541b35f877955d

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsharpe-0.0.1.tar.gz:

Publisher: release.yml on tschm/jsharpe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jsharpe-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: jsharpe-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jsharpe-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe68a90546c9067d93ee532a4c018be8b05626ad5b33a0482491e927efdd9657
MD5 11b724831ac715aa0dd49d72cd2359a2
BLAKE2b-256 2e7115157cf6307f141018af5f4a95d69d6805e4081c4d4da015d32333f23574

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsharpe-0.0.1-py3-none-any.whl:

Publisher: release.yml on tschm/jsharpe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page