{"id":19657717,"url":"https://github.com/esss/alfasim-score","last_synced_at":"2026-02-20T13:00:54.132Z","repository":{"id":243685375,"uuid":"811991121","full_name":"ESSS/alfasim-score","owner":"ESSS","description":"ALFAsim Score API integration","archived":false,"fork":false,"pushed_at":"2025-06-11T19:02:00.000Z","size":3630,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-12-22T02:34:07.504Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ESSS.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-06-07T18:07:36.000Z","updated_at":"2025-05-21T12:46:23.000Z","dependencies_parsed_at":"2024-06-28T13:38:20.846Z","dependency_job_id":"a8319846-9ff5-4d19-aa66-5901030e168b","html_url":"https://github.com/ESSS/alfasim-score","commit_stats":null,"previous_names":["esss/alfasim-score"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/ESSS/alfasim-score","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ESSS%2Falfasim-score","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ESSS%2Falfasim-score/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ESSS%2Falfasim-score/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ESSS%2Falfasim-score/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ESSS","download_url":"https://codeload.github.com/ESSS/alfasim-score/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ESSS%2Falfasim-score/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29651964,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T09:27:29.698Z","status":"ssl_error","status_checked_at":"2026-02-20T09:26:12.373Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2024-11-11T15:33:21.892Z","updated_at":"2026-02-20T13:00:54.084Z","avatar_url":"https://github.com/ESSS.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===============\nALFAsim Score\n===============\n\n\n.. image:: https://img.shields.io/pypi/v/alfasim-score.svg\n    :target: https://pypi.python.org/pypi/alfasim-score\n\n.. image:: https://img.shields.io/pypi/pyversions/alfasim-score.svg\n    :target: https://pypi.org/project/alfasim-score\n\n.. image:: https://github.com/ESSS/alfasim-score/workflows/test/badge.svg\n    :target: https://github.com/ESSS/alfasim-score/actions\n\n.. image:: https://codecov.io/gh/ESSS/alfasim-score/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/ESSS/alfasim-score\n\n.. image:: https://img.shields.io/readthedocs/alfasim-score.svg\n    :target: https://alfasim-score.readthedocs.io/en/latest/\n\n.. image:: https://sonarcloud.io/api/project_badges/measure?project=ESSS_alfasim-score\u0026metric=alert_status\n    :target: https://sonarcloud.io/project/overview?id=ESSS_alfasim-score\n\n\nWhat is alfasim-score?\n=======================\n\nPython package to convert the SCORE input JSON to Alfacase (ALFAsim input file).\n\n\nFeatures\n-----------\n\n* Converter from Score input JSON to Alfacase\n* Converter from Wellprop pvt tables to `.tab` pvt table format\n* Parser for the ALFAsim results and generate a JSON compatible with SCORE\n\nHow to use it\n-------------\n#. First, the user needs to create an instance of the converter::\n\n    from pathlib import Path\n    from alfasim_score.converter.alfacase.alfasim_score_converter import AlfasimScoreConverter\n    # path indicating where the SCORE input file is\n    score_input_filepath = Path(\"path/to/score_input.json\")\n    # path indicating where the output file (converted from ALFAsim results) should be created\n    score_output_filepath = Path(\"path/to/score_output_result.json\")\n    # then create a converter instance\n    alfacase_converter = AlfasimScoreConverter(score_input_filepath, score_output_filepath)\n\n#. To convert the SCORE input into an alfacase file, the user can do the following::\n\n    alfacase_filepath = Path(\"path/where/save/converted_score.alfacase\")\n    alfacase_converter.generate_alfasim_input_file(alfacase_filepath)\n\n#. Run the ALFAsim with the generated file (and the pvt tables in the same folder)\n\n#. Once the result file of ALFAsim is generated, one can call the converter for the output file::\n\n    alfasim_results_directory = Path(\"path/to/alfasim_results_folder\")\n    alfacase_converter.generate_score_output_file(alfasim_results_directory)\n\n#. The user also must remember to convert and save the pvt table (as `.tab` file) if wellprop tables are being used::\n\n    from alfasim_score.converter.wellprop.wellprop_pvt_table_converter import WellpropToPvtConverter\n    table_converter = WellpropToPvtConverter(Path(\"name_of_folder_with_wellprop_tables\"))\n    table_converter.generate_pvt_table_file(Path(\"name_of_folder_to_save_converted_pvt_table\"))\n\nDevelopment\n-----------\n\nFor complete description of what type of contributions are possible,\nsee the full `CONTRIBUTING \u003cCONTRIBUTING.rst\u003e`_ guide.\n\nHere is a quick summary of the steps necessary to setup your environment to contribute to ``alfasim-score``.\n\n#. Create a virtual environment and activate it::\n\n    $ python -m virtualenv .env\n    $ .env\\Scripts\\activate  # windows\n    $ source .env/bin/activate  # linux\n\n\n   .. note::\n\n       If you use ``conda``, you can install ``virtualenv`` in the root environment::\n\n           $ conda install -n root virtualenv\n\n       Don't worry as this is safe to do.\n\n#. Update ``pip``::\n\n    $ python -m pip install -U pip\n\n#. Install development dependencies::\n\n    $ pip install -e .[testing]\n\n#. Install pre-commit::\n\n    $ pre-commit install\n\n#. Run tests::\n\n    $ pytest --pyargs alfasim_score\n\n#. Generate docs locally::\n\n    $ tox -e docs\n\n   The documentation files will be generated in ``docs/_build``.\n\nRelease\n-------\n\nA reminder for the maintainers on how to make a new release.\n\nNote that the VERSION should folow the semantic versioning as X.Y.Z\nEx.: v1.0.5\n\n1. Create a ``release-VERSION`` branch from ``upstream/master``.\n2. Update ``CHANGELOG.rst``.\n3. Push a branch with the changes.\n4. Once all builds pass, push a ``VERSION`` tag to ``upstream``. Ex: ``git tag v1.0.5; git push origin --tags``\n5. Merge the PR.\n\n\n.. _`GitHub page` :                   https://github.com/ESSS/alfasim-score\n.. _pytest:                           https://github.com/pytest-dev/pytest\n.. _tox:                              https://github.com/tox-dev/tox\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesss%2Falfasim-score","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fesss%2Falfasim-score","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesss%2Falfasim-score/lists"}