{"id":28509537,"url":"https://github.com/snap-stanford/snapvx","last_synced_at":"2025-07-02T23:31:13.793Z","repository":{"id":25923792,"uuid":"29364907","full_name":"snap-stanford/snapvx","owner":"snap-stanford","description":null,"archived":false,"fork":false,"pushed_at":"2020-07-12T09:10:24.000Z","size":371,"stargazers_count":65,"open_issues_count":5,"forks_count":34,"subscribers_count":73,"default_branch":"master","last_synced_at":"2025-06-08T22:09:55.230Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snap-stanford.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-16T19:45:30.000Z","updated_at":"2024-05-01T05:24:08.000Z","dependencies_parsed_at":"2022-08-21T01:31:04.415Z","dependency_job_id":null,"html_url":"https://github.com/snap-stanford/snapvx","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/snap-stanford/snapvx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snap-stanford%2Fsnapvx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snap-stanford%2Fsnapvx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snap-stanford%2Fsnapvx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snap-stanford%2Fsnapvx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snap-stanford","download_url":"https://codeload.github.com/snap-stanford/snapvx/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snap-stanford%2Fsnapvx/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263232479,"owners_count":23434671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-08T22:08:59.424Z","updated_at":"2025-07-02T23:31:13.746Z","avatar_url":"https://github.com/snap-stanford.png","language":"Python","funding_links":[],"categories":["Software"],"sub_categories":["Python"],"readme":"SnapVX\n=====================\n\n**For more information, please visit the SnapVX website at [snap.stanford.edu/snapvx](http://snap.stanford.edu/snapvx/).**\n\n#### IMPORTANT LINKS\n- Source code repo: https://github.com/snap-stanford/snapvx\n- HTML user documentation: http://snap.stanford.edu/snapvx/doc/index.html\n- Developer documentation: http://snap.stanford.edu/snapvx/developer_doc.pdf\n- Issue Tracker: https://github.com/snap-stanford/snapvx/issues\n\n#### DEPENDENCIES\nThe required dependencies to build SnapVX are python 3, NumPy \u003e= 1.6.1, Scipy \u003e= 0.9, CVXPY \u003e= 1.25.0, and Snap.py \u003e= 1.2.\nThe github release only supports python 3, however snapvx-0.5 [here](http://snap.stanford.edu/snapvx/release/) is an older release supporting python 2.\n\n#### INSTALLATION\n1. Download the latest release [here](http://snap.stanford.edu/snapvx/release/).\n2. Uncompress the `snapvx-*.tar.gz` file.\n\n        tar zxvf snapvx-0.5.tar.gz\n\n3. Run `setup.py install` from inside the top-level directory.\n\n        cd snapvx-0.5\n        python setup.py install\n\n4. Test the installation. The included unit tests will test basic functionality to ensure that SnapVX and its dependencies are working correctly.\n\n        cd Tests\n        chmod u+x test_basic.sh\n        ./test_basic.sh\n\nNote: to run SnapVX locally, without installing it system-wide, just run setup.py with the --user flag.\n\n#### USAGE\nSnapVX is used by simply writing\n```\nimport snapvx\n```\nin the Python file. See the included `Examples/` directory for use cases and syntax.\n\n#### DEVELOPMENT\nPlease consult the developer doc for ways to contribute code, documentation, test cases and general improvments to SnapVX.\n\n### CONTACT\nPlease file bug reports at [github.com/snap-stanford/snapvx](https://github.com/snap-stanford/snapvx). We also encourage you to sign up for the [SnapVX mailing list](http://snap.stanford.edu/snapvx/#documentation) to stay up-tp-date with the newest features and releases. For any other questions, comments, or concerns, please contact [David Hallac](http://www.stanford.edu/~hallac/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnap-stanford%2Fsnapvx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnap-stanford%2Fsnapvx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnap-stanford%2Fsnapvx/lists"}