{ "info": { "author": "Martin Franckie", "author_email": "martin.franckie@phys.ethz.ch", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# aftershoq\nA Flexible Tool for Em-Radiation-emitting Semiconductor Heterostructure Optimization using Quantum models\n\nThis Tool aims to aid in the simulation of quantum cascade structures (such as QC lasers, detectors, or QWIPs)\nusing a variety of different simulation models. It also contains routines for optimization of such structures.\nIt contains a libraty of common materials and structures used in the Litterature, and provides a framework\nfor simulations. It does not contain any simualation code, this has to be provided by the users themselves\n(for now). The respective simulation code can be linked to [aftershoq] by the implementation of a subclass\nto Interface, which writes input files, executes the model, computes the merit function, and gathers the\nresults data.\n\nThis is a program written for Python 3.6. You need to have Python 3 installed to use and modify this software\nto your needs. The current implentation also uses numpy, scipy, matplotlib, and lxml for some features.\n\n\n# Installation\n\nWhen cloning, use the --recursive option:\n\ngit clone --recursive https://github.com/mfranckie/aftershoq.git\n\n(or\n\ngit clone --recurse-submodules https://github.com/mfranckie/aftershoq.git\n\ndepending on your git version) so that the project \"hilbert_curve\" appears in the base directory of aftershoq.\nTo install aftershoq and all its dependencies, execute\n\npython setup.py install\n\nfrom the aftershoq/ directory. To install on a system without root privileges, run\n\npython setyp.py install --user\n\ninsead.\n\n# Tutorials\n\nFor a demonstration, see the Jupyter notebooks located in examples/notebooks. To install Jupyter, run\n\npython -m pip install jupyter\n\nthen run with\n\njupyter notebook\n\n[Materials_guide.ipynb](https://github.com/mfranckie/aftershoq/blob/master/examples/notebooks/Materials_guide.ipynb) Shows how to create materials and alloys with varying composition and strain.\n\n[QCL_guide.ipynb](https://github.com/mfranckie/aftershoq/blob/master/examples/notebooks/QCL_guide.ipynb) Shows how to generate structures from scratch, how to load them from the [library](https://github.com/mfranckie/aftershoq/blob/master/aftershoq/qcls/qcls.py) and how to generate them automatically.\n\n[Opt_guide.ipynb](https://github.com/mfranckie/aftershoq/blob/master/examples/notebooks/Opt_guide.ipynb) Shows how to setup and run an optimization with Gaussian Processs (GP) regression for a test function and for a real QCL (requires ownership of a separate QCL simulation model).\n\n\nIf you don't want to/can't use jupyter, the following examples have a similar content:\n\n1) \"QCLexample.py\" (Requires a supported simulation program)\n2) \"example_sewself.py\" (Requires the sewself program)\n3) \"example_sewlab.py\" (Requires sewlab version 4.6.4 or later)\n4) \"test_optim.py\" (No requirements, this is a test of the optimization scheme)\n\nGood luck!\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mfranckie/aftershoq", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "aftershoq", "package_url": "https://pypi.org/project/aftershoq/", "platform": "", "project_url": "https://pypi.org/project/aftershoq/", "project_urls": { "Homepage": "https://github.com/mfranckie/aftershoq" }, "release_url": "https://pypi.org/project/aftershoq/1.0/", "requires_dist": [ "numpy", "scipy", "matplotlib", "lxml" ], "requires_python": ">=3.6", "summary": "A Flexible Tool for QCL/QCD Opitmization", "version": "1.0", "yanked": false, "yanked_reason": null }, "last_serial": 6006410, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "907a17891c76b0b339a4ac26ae38f52e", "sha256": "c399026ad81f7b226ce25a38552a34dcc4256ef26427d73185ccb1b8656207ad" }, "downloads": -1, "filename": "aftershoq-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "907a17891c76b0b339a4ac26ae38f52e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 115056, "upload_time": "2019-10-21T09:29:20", "upload_time_iso_8601": "2019-10-21T09:29:20.174815Z", "url": "https://files.pythonhosted.org/packages/1f/e9/1cfd0a9f80e645eb3620ec6d8bb01fadb134b16123ddd1329af604e03d40/aftershoq-0.1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "503b484fd5d747277ce1bb661e323a0f", "sha256": "a78376647d057e6ec4809865af61b05ef3f2ddf3a6e582d3e31312c5ec4e2c72" }, "downloads": -1, "filename": "aftershoq-0.1.0.tar.gz", "has_sig": false, "md5_digest": "503b484fd5d747277ce1bb661e323a0f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 88044, "upload_time": "2019-10-21T09:29:25", "upload_time_iso_8601": "2019-10-21T09:29:25.442783Z", "url": "https://files.pythonhosted.org/packages/da/f6/4bd609f28a0714bda7a2c3438634b9d839bfc152488a8adfe699b7fc460d/aftershoq-0.1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0": [ { "comment_text": "", "digests": { "md5": "ffa78498f92a183644fd907a91542a45", "sha256": "af67f1b0e9c21cf496bebedfadc01f7ca5ad7882f17f415e8f170457bb84c11b" }, "downloads": -1, "filename": "aftershoq-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "ffa78498f92a183644fd907a91542a45", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 114720, "upload_time": "2019-10-21T09:29:23", "upload_time_iso_8601": "2019-10-21T09:29:23.463567Z", "url": "https://files.pythonhosted.org/packages/2b/fc/5295193f8836766c8a864a8b4497eb7c04ee925ea5b01156ea11f102f858/aftershoq-1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "e21efdd99e07ef39431aabb63aef3061", "sha256": "05212017d37fb44d0b5fa0dfb1d3919322639612467e5c8d5409e64f96f6ec46" }, "downloads": -1, "filename": "aftershoq-1.0.tar.gz", "has_sig": false, "md5_digest": "e21efdd99e07ef39431aabb63aef3061", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 87771, "upload_time": "2019-10-21T09:29:26", "upload_time_iso_8601": "2019-10-21T09:29:26.914493Z", "url": "https://files.pythonhosted.org/packages/92/46/d4a0266a558908efd1c768f24db587b6c0bbd2265c0f379e723caabbf8cc/aftershoq-1.0.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ffa78498f92a183644fd907a91542a45", "sha256": "af67f1b0e9c21cf496bebedfadc01f7ca5ad7882f17f415e8f170457bb84c11b" }, "downloads": -1, "filename": "aftershoq-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "ffa78498f92a183644fd907a91542a45", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 114720, "upload_time": "2019-10-21T09:29:23", "upload_time_iso_8601": "2019-10-21T09:29:23.463567Z", "url": "https://files.pythonhosted.org/packages/2b/fc/5295193f8836766c8a864a8b4497eb7c04ee925ea5b01156ea11f102f858/aftershoq-1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "e21efdd99e07ef39431aabb63aef3061", "sha256": "05212017d37fb44d0b5fa0dfb1d3919322639612467e5c8d5409e64f96f6ec46" }, "downloads": -1, "filename": "aftershoq-1.0.tar.gz", "has_sig": false, "md5_digest": "e21efdd99e07ef39431aabb63aef3061", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 87771, "upload_time": "2019-10-21T09:29:26", "upload_time_iso_8601": "2019-10-21T09:29:26.914493Z", "url": "https://files.pythonhosted.org/packages/92/46/d4a0266a558908efd1c768f24db587b6c0bbd2265c0f379e723caabbf8cc/aftershoq-1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }