{
    "info": {
        "author": "R.J. Skolasinski",
        "author_email": "r.j.skolasinski@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "Intended Audience :: Science/Research",
            "Operating System :: POSIX",
            "Operating System :: Unix",
            "Programming Language :: Python :: 3 :: Only",
            "Topic :: Scientific/Engineering",
            "Topic :: Software Development"
        ],
        "description": "# semicon - k\u00b7p simulations made easy\n\nNote: this is work in progress, comments and ideas are more than welcomed!\n\nThe goal of this package is to provide easy to use framwerok for performing k\u00b7p simulations.\nThere will be two main components of this framework: parameters and models.\n\nThis package is suppose to remove an overhead and a boiler plate that appears when doing the k\u00b7p simulations.\nIt is suppose to make things easier, therefore userfriendly interface is a priority.\n\n\n# Models\n\nModels are based on the k\u00b7p Kane Hamiltonian, symmetrized following Burt-Foreman approach.\nUsers should be able to choose which components (Zeeman, Dresselhaus, strain, ...) and which bands ('gamma_6c', 'gamma_8v', ...) shall be included.\n\n\n# Parameters\n\nParameters bank should include most common semiconducting materials.\nHelper functions should handle parameter renormalization based on included bands and way to avoid spurious solutions.\n\n\n# Helper functions\n\nGoal of this framework is to make k.p simulations easy.\nHowever, building the actual Kwant system and peforming the simulation should be done by user and this library only provide helper tools that are specific to problems encountered in k.p simulations\n\n\n# Requirements\n\n* This package is suppose to work with latest stable release of Kwant.\n* This package will require [SciPy 1.2](https://github.com/scipy/scipy/milestone/36) that is scheduled to be released in November 2018.\nThis is due to usage of [scipy.spatial.transform.Rotation](https://scipy.github.io/devdocs/generated/scipy.spatial.transform.Rotation.html#scipy.spatial.transform.Rotation) to find the rotation vector of a given rotation matrix.\n* Because project is based on discretizer sympy is required, however, due to compatibility [issue](https://gitlab.kwant-project.org/kwant/kwant/issues/225) it must be in version lower than 1.2\n\n\n# Installation\nAs this package is pure python standard python installation from sources with\n```\npython setup.py build\npython setup.py install\n```\nshould be working without problems.\nThe only non-trivial dependency, Kwant, that could cause problemS if not installed beforehand can be either obtained via ``conda`` or any other installation means explained on its [homepage](https://kwant-project.org/).\n\nDirect installation from git is also possible (and favoured as long as conda\npackage is not out there):\n```\npip install git+https://gitlab.kwant-project.org/semicon/semicon.git\n```\n\nNote that due to active development master branch may not be stable.\nTo install version that has been already used in research project use\n```\npip install git+https://gitlab.kwant-project.org/semicon/semicon.git@v0.1.0\n```\n\n\n# Tips about developing inside docker container\n\nOne can easily use a [rafalskolasinski/science](https://github.com/RafalSkolasinski/science-docker)\nDocker container for a development of this project.\nAssuming that ``semicon`` folder is ``~/work/semicon`` do:\n```\ndocker pull rafalskolasinski/science:semicon\ndocker run -d -p 8888:8888 --name semicon \\\n    -v ~/work/semicon:/src -v ~/work/semicon/notebooks:/home/jovyan/work \\\n    rafalskolasinski/science:semicon\n```\n\nThis will mount source code in ``/src`` and project notebooks in ``~/work``\ninside the containier. It will also start ``jupyter notebook`` server running\nat ``localhost:8888``. You will need to read jupyter's server token with\n``docker logs semicon`` to access the server.\n\nYou can now use ``docker exec semicon build`` and ``docker exec semicon test``\nto build the package or run the tests respectively.\n\nYou can enter bash inside the container by running\n```\ndocker exec -it semicon bash\n```\n\nNicely formatted output of tests (colors):\n```\ndocker exec -it semicon test -v\n```\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://gitlab.kwant-project.org/semicon/semicon",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "semicon",
        "package_url": "https://pypi.org/project/semicon/",
        "platform": "Unix",
        "project_url": "https://pypi.org/project/semicon/",
        "project_urls": {
            "Homepage": "https://gitlab.kwant-project.org/semicon/semicon"
        },
        "release_url": "https://pypi.org/project/semicon/0.2.0/",
        "requires_dist": [
            "pyyaml",
            "scipy (>=0.17)",
            "kwant (>=1.3)",
            "sympy (>=1.1.1)",
            "pandas (>=0.19.2)"
        ],
        "requires_python": "",
        "summary": "Package for simulating quantum mechanical k\u00b7p Hamiltonians",
        "version": "0.2.0"
    },
    "last_serial": 4616296,
    "releases": {
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1daecd5d0fde17552319f97988012c5e",
                    "sha256": "5aff4855e3598e722eea8de3d96a6779f907777f3b941d4ade1c7b28eebff0ac"
                },
                "downloads": -1,
                "filename": "semicon-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1daecd5d0fde17552319f97988012c5e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 25878,
                "upload_time": "2018-12-14T15:12:44",
                "url": "https://files.pythonhosted.org/packages/15/85/8b9b0b50c4bb16bb92cfb50ffa7d9f6637b954fd471e6aff1b2785ea9e11/semicon-0.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "68ed72c47b8eb4d0dff522cc0dda283d",
                    "sha256": "2e72b566634a005866c57d4b54dcf6b8b678ca94be526b198b715b643551c8ce"
                },
                "downloads": -1,
                "filename": "semicon-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "68ed72c47b8eb4d0dff522cc0dda283d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21413,
                "upload_time": "2018-12-14T15:12:47",
                "url": "https://files.pythonhosted.org/packages/b9/a0/0f7f36f059a69f66a0dae4b28b8a3f49404031e366100fd09dcb3c8fcb1b/semicon-0.2.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1daecd5d0fde17552319f97988012c5e",
                "sha256": "5aff4855e3598e722eea8de3d96a6779f907777f3b941d4ade1c7b28eebff0ac"
            },
            "downloads": -1,
            "filename": "semicon-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1daecd5d0fde17552319f97988012c5e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 25878,
            "upload_time": "2018-12-14T15:12:44",
            "url": "https://files.pythonhosted.org/packages/15/85/8b9b0b50c4bb16bb92cfb50ffa7d9f6637b954fd471e6aff1b2785ea9e11/semicon-0.2.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "68ed72c47b8eb4d0dff522cc0dda283d",
                "sha256": "2e72b566634a005866c57d4b54dcf6b8b678ca94be526b198b715b643551c8ce"
            },
            "downloads": -1,
            "filename": "semicon-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "68ed72c47b8eb4d0dff522cc0dda283d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 21413,
            "upload_time": "2018-12-14T15:12:47",
            "url": "https://files.pythonhosted.org/packages/b9/a0/0f7f36f059a69f66a0dae4b28b8a3f49404031e366100fd09dcb3c8fcb1b/semicon-0.2.0.tar.gz"
        }
    ]
}