{"id":34942228,"url":"https://github.com/abinit/abimkdocs_v9.2.1","last_synced_at":"2026-04-02T14:56:32.874Z","repository":{"id":330318825,"uuid":"1122391145","full_name":"abinit/abimkdocs_v9.2.1","owner":"abinit","description":null,"archived":false,"fork":false,"pushed_at":"2025-12-24T16:23:54.000Z","size":82333,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-12T23:27:44.949Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abinit.png","metadata":{"files":{"readme":"README","changelog":"ChangeLog","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-24T16:18:09.000Z","updated_at":"2025-12-24T16:23:58.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/abinit/abimkdocs_v9.2.1","commit_stats":null,"previous_names":["abinit/abimkdocs_v9.2.1"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/abinit/abimkdocs_v9.2.1","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abinit%2Fabimkdocs_v9.2.1","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abinit%2Fabimkdocs_v9.2.1/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abinit%2Fabimkdocs_v9.2.1/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abinit%2Fabimkdocs_v9.2.1/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abinit","download_url":"https://codeload.github.com/abinit/abimkdocs_v9.2.1/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abinit%2Fabimkdocs_v9.2.1/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31308470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":"2025-12-26T19:23:31.090Z","updated_at":"2026-04-02T14:56:32.868Z","avatar_url":"https://github.com/abinit.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Getting started with mkdocs\n\n!!! warning\n    \n    The code supports py2.7 and python3.6 but py3k is **strongly** suggested\n    especially when building the final version before deploying \n    as py3k has native support for unicode.\n\nInstall the python packages required to build the static website with:\n\n    pip install -r requirements.txt\n\nthen install the mkdocs plugin with:\n\n    cd abimkdocs_plugin\n    python setup.py install\n\nIf you use conda, you may want to create a new environment based on python3.6 with:\n\n    conda create -n abinit-abimkdocs-2 python=3.6\n    source activate abinit-abimkdocs\n\nand then install the packages with pip (see above commands).\n\nMkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it. \nMake sure you are in `~abinit`, and then start *our customized* server \nby running the `mksite.py` serve command with the `--dirtyreload` option:\n\n```console\n$ ./mksite.py serve --dirtyreload\nRegenerating database...\nSaving database to /Users/gmatteo/git_repos/abidocs/doc/tests/test_suite.cpkl\nInitial website generation completed in 9.17 [s]\nGenerating markdown files with input variables of code: `abinit`...\n...\n...\nINFO    -  Building documentation...\nINFO    -  Cleaning site directory\n[I 170826 03:37:05 server:283] Serving on http://127.0.0.1:8000\n[I 170826 03:37:05 handlers:60] Start watching changes\n[I 170826 03:37:05 handlers:62] Start detecting changes\n```\n\nOpen up `http://127.0.0.1:8000/` in your browser, and you'll see the default home page being displayed.\n\nUse:\n\n    $ ./mksite.py --help\n\nto get the list of commands and:\n\n    $ ./mksite.py COMMAND --help\n\nto get the documentation of `COMMAND`.\n\n## Notes\n\ntopics are still in Yaml format\nwikilink syntax: \u003cspan style=\"background-color: #E0E0E0;font-size:90%;\"\u003e \u0026#91; [names|text] \u0026#93; \u003c/span\u003e will become \u003cspan style=\"background-color: #E0E0E0;font-size:90%;\"\u003e \u0026#91; [text|namespace] \u0026#93; \u003c/span\u003e.\n\n## Troubleshooting\n\nIf you get error message about ASCII being used as default encoding on your machine add:\n\n    export LC_ALL=en_US.UTF-8  \n    export LANG=en_US.UTF-8\n\nto your ~/.bashrc and source it\n\n## How to add new variables\n\nThe yaml database has been replaced by python modules.\nThe variables are now declared in `~abinit/abimkdocs/variables_CODENAME.py`.\n\nThis file consists of a list of dictionaries, each dictionary\ncontains the declaration of a single variable and the associated documentation in markdown format.\nWikilinks, latex and markdown extensions can be used inside `text`.\nThis is, for example, the declaration of the `accuracy` variable in python:\n\n```python\nVariable(\n    abivarname=\"accuracy\",\n    varset=\"basic\",\n    vartype=\"integer\",\n    topics=['Planewaves_basic', 'SCFControl_basic'],\n    dimensions=\"scalar\",\n    defaultval=0,\n    mnemonics=\"ACCURACY\",\n    text=\"\"\"\nAllows to tune the accuracy of a calculation by setting automatically the\nvariables according to the following table:\n\naccuracy         | 1         | 2          | 3            | 4            | 5         | 6\n---              |---        |---         |---           |---           |---        |---\n[[ecut]]         | E_min     | E_med      | E_med        | E_max        | E_max     | E_max\n[[pawecutdg]]    | ecut      | ecut       | 1.2 * ecut   | 1.5 * ecut   | 2 * ecut  | 2 * ecut\n[[fband]]        | 0.5       | 0.5        | 0.5          | 0.5          | 0.75      | 0.75\n...\n\nFor a parallel calculation, [[timopt]] is enforced to be 0.\n...\n\"\"\",\n),\n```\n\nAdding a new variable is easy. Edit the python module and add a new item at the end of the list. \nA template is provided ...\n\n\n## How to add a new bibtex entry\n\nCitations must be in bibtex format and provide enough information so that the python code\ncan generate appropriated links in the website.\nFor published work with a DOI, we strongly recommend *avoiding* a `cut\u0026paste` from your bibtex files\n(there are units tests to enforce the presence of particular entries in the bibtex document and\nyour bibtex may not fullfill these requirements).\n\nA much better solution is to use BetterBib and the DOI of the article to fetch data \nfrom Crossref and produce the bibtex entry. \nBetterBib is available from the Python Package Index, so simply type:\n\n    pip install betterbib\n\nand then use doi2bibtex from the command line:\n\n    doi2bibtex 10.1103/PhysRevLett.96.066402\n\nAdd the entry to the bibtex file and use the `FirstAuthorYear` convention for the key \n(make sure it's not a duplicated entry).\nNote that the bibtex ID must be of the form \"FirstauthornameYEAR\", e.g. \"Amadon2008\" \n(start with an uppercase letter, then lower case, then four-digit year). \nPossibly, a letter might be added in case of ambiguity: e.g. there exists also `Amadon2008a`\nThen, build the HTML pages using `mksite.py serve`.\n\nRun the tests in `./tests/test_bibtex.py` with pytest (see next section) to validate your changes.\n\n## Running the unit tests\n\nUnit tests are located in the ./tests directory. \nTo execute the tests, install `pytest` with:\n\n    pip install pytest\n\nand then:\n\n    pytest -v ./tests/\n\nUse \n\n    pytest -v ./tests/test_variables.py\n\nto execute a particular module.\n\n## Checking links with linkchecker\n\nBuild the website with:\n\n    ./mksite.py build\n\nthen use\n\n    linkchecker site/index.html \u003e links.err\n\n!!! important\n\n    For the time being, linkchecker python2.7\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabinit%2Fabimkdocs_v9.2.1","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabinit%2Fabimkdocs_v9.2.1","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabinit%2Fabimkdocs_v9.2.1/lists"}