Skip to content

Commit

Permalink
project url and updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tschm committed Dec 17, 2024
1 parent bbd0989 commit 5268723
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,25 +51,26 @@ You can install the package via [PyPI](https://pypi.org/project/cvxmarkowitz/):
pip install cvxmarkowitz
```

## Poetry
## uv

We assume you share already the love for [Poetry](https://python-poetry.org).
Once you have installed poetry you can perform
You need to install [task](https://taskfile.dev).
Starting with

```bash
make install
task simulator:install
```

to replicate the virtual environment we have defined in
[pyproject.toml](pyproject.toml) and fixed in [poetry.lock](poetry.lock).
will install [uv](https://github.com/astral-sh/uv) and create
the virtual environment defined in
pyproject.toml and locked in uv.lock.

## Support for Jupyter
## marimo

you could install [JupyterLab](https://jupyter.org) within your new
We install [marimo](https://marimo.io) on the fly within the aforementioned
virtual environment. Executing

```bash
make jupyter
task simulator:marimo
```

installs JupyterLab in your virtual environment for the project.
will install and start marimo.
4 changes: 3 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ readme = "README.md"

#authors = ["Thomas Schmelzer", "Kasper Johansson", "Philipp Schiele", "Stephen Boyd"]
#readme = "README.md"
repository = "https://github.com/cvxgrp/cvxmarkowitz"
requires-python = ">=3.10"
dependencies = [
"cvxpy-base>=1.6.0",
Expand All @@ -16,6 +15,9 @@ dependencies = [
"typing-extensions"
]

[project.urls]
repository = "https://github.com/cvxgrp/cvxmarkowitz"

[dependency-groups]
dev = [
"pytest-cov>=6.0.0",
Expand Down

0 comments on commit 5268723

Please sign in to comment.