Skip to main content

Sharpe ratio

Project description

📦 jsharpe

PyPI version License: MIT CI Created with qCradle

🚀 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.1.0.tar.gz (12.7 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.1.0-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jsharpe-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8a77e3ad1a697a6c59c00e796373ec192f6e0251cd2ba67f2c940295889f6b46
MD5 b236c95dde104b950053c6df65df0950
BLAKE2b-256 69e2efacc6b9de80587c34a21c5b4cfc194d886643f27337c3ff90cf5c64402c

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsharpe-0.1.0.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: jsharpe-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.8 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 38decc828bac53ff1a10b4c18a1c7e3e0d6d366e666465be9b8577bd417b4f84
MD5 a768d911da2d0594e54840372989f379
BLAKE2b-256 95bf7bb72fe82aa688bcc0d95bd49fc7f016c6c899cdf57f300ee874cc29f183

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsharpe-0.1.0-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