A fast and general ADMM solver
=======================================================================
# Installation
```
pip3 install admmsolver
```
# Implementation note
[Implementation note](https://www.overleaf.com/read/fxbjmzsvwtgh)
# How to develop using VS code + docker
1. Install `Remote Development` extension of VS code.
2. Clone the repository and open the cloned directory by VS code.
3. You will be asked if you want to reopen the directory in a container. Say yes!<br>
(The first time you start a docker container, a docker image is built. This takes a few minutes).
4. Once you login in the container, all required Python packages are pre-installed and `PYTHONPATH` is set to `src`.
5. To run all unit tests and static type checkes by `mypy`, use ```./bin/runtests.sh```.
Note:
* The cloned git repository on your host file system is mounted on the working directory in the container. Created files in the container will be persisted even after the container stops.
* The full list of what are installed in the container will be found in `.devcontainer/Dockerfile`.
* If you customize `Dockerfile` and build an image for debugging, execute the command shown below on your host machine.
```
docker build -f .devcontainer/Dockerfile .
```
Raw data
{
"_id": null,
"home_page": "https://github.com/SpM-lab/admmsolver",
"name": "admmsolver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "ADMM",
"author": "Hiroshi Shinaoka",
"author_email": "h.shinaoka@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/78/38/3d9463df6bd6e2cd8d5d0d01be53064ca35261ea457b4819638de426c8f3/admmsolver-0.7.7.tar.gz",
"platform": null,
"description": "A fast and general ADMM solver\n=======================================================================\n# Installation\n\n```\npip3 install admmsolver\n```\n\n# Implementation note\n[Implementation note](https://www.overleaf.com/read/fxbjmzsvwtgh)\n\n# How to develop using VS code + docker\n1. Install `Remote Development` extension of VS code.\n2. Clone the repository and open the cloned directory by VS code.\n3. You will be asked if you want to reopen the directory in a container. Say yes!<br>\n(The first time you start a docker container, a docker image is built. This takes a few minutes).\n4. Once you login in the container, all required Python packages are pre-installed and `PYTHONPATH` is set to `src`.\n5. To run all unit tests and static type checkes by `mypy`, use ```./bin/runtests.sh```.\n\nNote:\n* The cloned git repository on your host file system is mounted on the working directory in the container. Created files in the container will be persisted even after the container stops.\n* The full list of what are installed in the container will be found in `.devcontainer/Dockerfile`.\n* If you customize `Dockerfile` and build an image for debugging, execute the command shown below on your host machine.\n```\ndocker build -f .devcontainer/Dockerfile .\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Fast and general ADMM solver",
"version": "0.7.7",
"project_urls": {
"Homepage": "https://github.com/SpM-lab/admmsolver"
},
"split_keywords": [
"admm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd4d1a4ec6ee5fcf324d4ed34ca973a88378d1f1b1a5c26b311d7b0f027ea3b4",
"md5": "23bc271981de839b45c1231ba7ec0b98",
"sha256": "2a10df72b38dcf8146cd8fb1f6eb84cf4bcf1d53697bb1dd261210494e333ad0"
},
"downloads": -1,
"filename": "admmsolver-0.7.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "23bc271981de839b45c1231ba7ec0b98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 13062,
"upload_time": "2024-06-07T08:05:07",
"upload_time_iso_8601": "2024-06-07T08:05:07.108804Z",
"url": "https://files.pythonhosted.org/packages/cd/4d/1a4ec6ee5fcf324d4ed34ca973a88378d1f1b1a5c26b311d7b0f027ea3b4/admmsolver-0.7.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "78383d9463df6bd6e2cd8d5d0d01be53064ca35261ea457b4819638de426c8f3",
"md5": "5971a9d1b1ce2f77e0a001d3c1751b87",
"sha256": "f3c760de46821f1d863b9d0942e7faebb4a54f9ac6861d54ced82c42f62e16d4"
},
"downloads": -1,
"filename": "admmsolver-0.7.7.tar.gz",
"has_sig": false,
"md5_digest": "5971a9d1b1ce2f77e0a001d3c1751b87",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16490,
"upload_time": "2024-06-07T08:05:09",
"upload_time_iso_8601": "2024-06-07T08:05:09.227837Z",
"url": "https://files.pythonhosted.org/packages/78/38/3d9463df6bd6e2cd8d5d0d01be53064ca35261ea457b4819638de426c8f3/admmsolver-0.7.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-07 08:05:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SpM-lab",
"github_project": "admmsolver",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "admmsolver"
}
JSON
