{"id":21823119,"url":"https://github.com/cellml/cellml-specification","last_synced_at":"2025-03-21T11:26:38.104Z","repository":{"id":18686016,"uuid":"21895588","full_name":"cellml/cellml-specification","owner":"cellml","description":"CellML Specification","archived":false,"fork":false,"pushed_at":"2023-08-21T23:12:22.000Z","size":1530,"stargazers_count":0,"open_issues_count":32,"forks_count":8,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-01-26T07:43:42.205Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"NASL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cellml.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-16T10:03:18.000Z","updated_at":"2022-09-19T23:38:19.000Z","dependencies_parsed_at":"2023-02-17T08:45:25.111Z","dependency_job_id":null,"html_url":"https://github.com/cellml/cellml-specification","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cellml%2Fcellml-specification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cellml%2Fcellml-specification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cellml%2Fcellml-specification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cellml%2Fcellml-specification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cellml","download_url":"https://codeload.github.com/cellml/cellml-specification/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244788929,"owners_count":20510462,"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":"2024-11-27T17:19:46.113Z","updated_at":"2025-03-21T11:26:38.068Z","avatar_url":"https://github.com/cellml.png","language":"NASL","funding_links":[],"categories":[],"sub_categories":[],"readme":"\nCellML Specification\n====================\n\nThis repository will be used by the CellML editors to develop the CellML specification (starting with the discontinued version 1.2)\nThe content has been reworked to include an informal guide embedded within the normative specification text (in version 2.0).\n\nIf things work correctly, changes in this repository will be reflected over at: https://cellml-specification.readthedocs.org/.\nAny pull requests opened will also be built on read the docs.\n\nBuilding the documentation locally\n----------------------------------\n\nThe documentation can be built on your local machine with the following instructions.\nDo take note that the following instructions are suitable for Unix-derived operating systems and may need modification for other operating systems.\nAlso, note that we require at least version 3.5 of Python to build the documentation.\n\nFirst clone a local copy of the CellML specification repository::\n\n  git clone https://github.com/cellml/cellml-specification.git\n\nNext setup a virtual environment::\n\n  virtualenv venv_specification\n\n**Note:** make sure you are creating virtual environment using a suitable Python interpreter, if required use the ``-p`` flag to set the Python interpreter (for example ``virtualenv -p /absolute/path/to/python venv_specification``).\n\nThen activate the virtual environment and instal the required packages::\n\n  source venv_specification/bin/activate\n  pip install -r cellml-specification/requirements.txt\n\nThat completes the environment setup required for building the documentation.\nOnce the environment is completed, the HTML form of the documentation can be built with the following commands::\n\n  cd cellml-specification\n  make html\n\nThe built documentation will be available at::\n\n  /absolute/path/to/cellml-specification/build/html/index.html\n\nAny good internet browser will be able to display the documentation (see also `Serving the documentation`_).\n\nTo build the documentation into a single page HTML document execute the following command::\n\n  make singlehtml\n\nThe built documentation will be available at::\n\n  /absolute/path/to/cellml-specification/build/singlehtml/index.html\n\nBuilding PDFs\n^^^^^^^^^^^^^\n\nTo build the PDF form of the documentation, simply execute the following command::\n\n  make latexpdf\n\nIf this fails, please have a look at the following:\n\nCreating the PDF form of the documentation requires that some or all of a tool like Windows/`MikTeX \u003chttps://miktex.org/\u003e`_, Windows/`TeXlive \u003chttps://www.tug.org/texlive/\u003e`_, Linux/`TeXlive \u003chttps://www.tug.org/texlive/\u003e`_, and macOS/`MacTeX \u003chttps://tug.org/mactex/\u003e`_ is available to the Sphinx build tool.\n\nIn addition, you'll need the following LaTeX packages: ``babel-greek``, ``capt-of``, ``cbfonts``, ``courier``, ``fncychap``, ``fontspec``, ``framed``, ``greek-fontenc``, ``helvetic``, ``latexmk``, ``needspace``, ``tabulary``, ``textgreek``, ``titlesec``, ``tocloft``, ``varwidth``, and ``wrapfig``.\n\nIn particular, check that you have ``latexmk`` available as this is required for creating the PDF form of the documentation.\nInformation on ``latexmk`` can be found at https://ctan.org/pkg/latexmk/.\n\nYou may also need to install the `\"GNU FreeFont\" fonts \u003chttps://www.gnu.org/software/freefont/\u003e`_ ``FreeSans``, ``FreeSerif``, and ``FreeMono``.\n\nDocumentation builds\n^^^^^^^^^^^^^^^^^^^^\n\nThere are two types of build that can be created from this codebase, they can be selected through the use of the environment variable ``CELLML_SPEC_BUILD``.\n\n1. Normative only, set ``CELLML_SPEC_BUILD=Normative`` (default build).\n2. Normative and informative specification combined, set ``CELLML_SPEC_BUILD=Full``\n\nServing the documentation\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nYou can serve the documentation locally using a simple Python server.\nSave the following text to a file named ``webserver.py`` (this file can be saved anywhere on your harddrive)::\n\n  #!/usr/bin/env python\n\n  import http.server\n  import socketserver\n\n  PORT = 8008\n  Handler = http.server.SimpleHTTPRequestHandler\n\n  with socketserver.TCPServer((\"\", PORT), Handler) as httpd:\n      print(\"Serving at port\", PORT)\n      httpd.serve_forever()\n\nTo run the web server, use a terminal type application and change directory into::\n\n  cd /absolute/path/to/cellml-specification/build/html/\n\nthen run the command::\n\n  python /absolute/path/to/webserver.py\n\nNow launch your internet browser and open the location::\n\n  http://localhost:8008/\n\nBuilding the documentation for cellml.org\n-----------------------------------------\n\nThe documentation required for cellml.org can be built from this repository.\nThe documenation can be built by setting the variable `target_cellml_org` to `True` in the `conf.py` file and then building the documentation with the single html builder.\nWith `target_cellml_org = True` saved in the `conf.py` file the command::\n\n  make singlehtml\n\nwill create a file `index.html` in the directory `build/singlehtml` relative to the root of the repository directory.\nThe contents of the `index.html` can be copied and pasted into cellml.org.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcellml%2Fcellml-specification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcellml%2Fcellml-specification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcellml%2Fcellml-specification/lists"}