{
    "info": {
        "author": "Brookhaven National Lab",
        "author_email": "yilinwang@bnl.gov",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Natural Language :: English",
            "Programming Language :: Python :: 3"
        ],
        "description": "===============================\nedrixs\n===============================\n\n.. image:: https://img.shields.io/travis/NSLS-II/edrixs.svg\n        :target: https://travis-ci.org/NSLS-II/edrixs\n\n.. image:: https://img.shields.io/pypi/v/edrixs.svg\n        :target: https://pypi.python.org/pypi/edrixs\n\n\nAn open source toolkit for simulating RIXS spectra based on exact diagonalization (ED) for strongly correlated materials.\n`It is developed <https://www.bnl.gov/comscope/software/EDRIXS.php>`_ as part of `COMSCOPE project <https://www.bnl.gov/comscope/software/comsuite.php/>`_ in the Center for Computational Material Spectroscopy and Design, Brookhaven National Laboratory\n\n* Free software: GNU General Public License Version 3\n* Documentation: https://nsls-ii.github.io/edrixs.\n\nFeatures\n--------\n\n* ED solver\n* XAS spectra\n* RIXS spectra\n\nInstallation\n------------\n* Required tools and libraries\n\n   * Fortran compiler: gfortran and ifort are supported \n   * MPI environment: openmpi and mpich are tested\n   * mpif90 (binding with gfortran or ifort) and mpicc (binding with gcc)\n   * Python3\n   * BLAS and LAPACK: gfortran+OpenBLAS or ifort+MKL\n   * arpack-ng (with mpi enabled)\n   * Numpy\n   * Scipy\n   * Sympy\n   * Matplotlib\n   * mpi4py\n   * Sphinx\n   * Numpydoc\n\n  Be sure to compile OpenBLAS, arpack-ng, mpi4py and edrixs with the same (MPI) Fortran compiler.\n\n* Install Fortran parts of edrixs\n\n    .. code-block:: bash\n\n       $ cd src\n       $ make F90=mpif90 LIBS=\"-L/usr/local/lib -lopenblas -lparpack -larpack\"\n       $ make install\n\n  where, you may need to change ``F90`` and ``LIBS`` according to your specific environment. There will be problems when using gfortran with MKL, so we recommend ``gfortran+OpenBLAS`` or ``ifort+MKL``. ``libedrixsfortran.a`` will be generated, which will be used when building python interface. The executable ``.x`` files will be installed in ``edrixs/bin`` directory and add the following line in ``.bashrc`` or ``.bash_profile`` file,\n\n    .. code-block:: bash\n\n       export PATH=/root_dir_of_edrixs/edrixs/bin:$PATH\n\n* Install Python parts of edrixs\n\n  Be sure to first make ``libedrixsfortran.a`` in src.\n\n    .. code-block:: bash\n\n       $ python setup.py config_fc --f77exec=mpif90 --f90exec=mpif90 build_ext \\\n         --libraries=openblas,parpack,arpack --library-dirs=/usr/lib:/usr/local/lib:/opt/local/lib \\\n         --link-objects=./src/libedrixsfortran.a\n       $ pip install .\n\n  where, ``--library-dirs`` ares the paths to search ``--libraries``, please set it according to your environments.\n\n\nRun edrixs in docker\n--------------------\nTo make life easier, we have built a docker image based on Ubuntu Linux (18.04) for edrixs, so you don't need to struggle with the installation anymore. \nThe docker image can be used on any OS as long as the `docker <https://www.docker.com/>`_ application are available.\nFollow these steps to use the docker image:\n\n* Install the `docker <https://www.docker.com/>`_ application on your system and `learn how to use it <https://docs.docker.com/get-started/>`_.\n* Once the docker is running, create a directory to store data in your host OS and launch a container to run edrixs\n\n    .. code-block:: bash\n      \n       $ mkdir /dir/on/your/host/os   # A directory on your host OS\n       $ docker pull edrixs/edrixs    # pull latest version\n       $ docker run -it -p 8888:8888 -u rixs -w /home/rixs -v /dir/on/your/host/os:/home/rixs/data edrixs/edrixs\n       \n  it will take a while to pull the image from `Docker Hub <https://cloud.docker.com/repository/docker/edrixs/edrixs/>`_ for the first time, while, it will launch the local one very fast at the next time.\n  \n  * ``-p 8888:8888`` maps container's port 8888 to host port 8888.\n  * ``-u rix`` means using a default user ``rixs`` to login the Ubuntu Linux, the password is ``rixs``. \n  * ``-v /dir/on/your/host/os:/home/rixs/dat`` means mounting the directory ``/dir/on/your/host/os`` from your host OS to  ``/home/rixs/data`` on the Ubuntu Linux in the container. \n   \n* After launching the container, you will see ``data`` and ``edrixs_examples`` in ``/home/rixs`` directory. If you want to save the data from edrixs calculations to your host system, you need to work in ``/home/rixs/data`` directory.\n\n    .. code-block:: bash\n    \n       $ cd /home/rixs/data\n       $ cp -r ../edrixs_examples .\n       $ Play with edrixs ... \n\n  Note that any changes outside ``/home/rixs/data`` will be lost when this container stops. You can only use your host OS to make interactive plots. Use ``sudo apt-get install`` to install softwares if they are needed. \n  \n* Type ``exit`` in the container to exit. You can delete all the stopped containers by\n\n   .. code-block:: bash\n      \n      $ docker rm $(docker ps -a -q)\n\n* You can delete the edrixs image by\n\n   .. code-block:: bash\n   \n      $ docker rmi edrixs/edrixs   \n\n\nHow to cite\n-----------\nIf you are using the EDRIXS code to do some studies and would like to publish your great works, it would be really appreciated if you can cite the following paper\n\n .. code-block:: bash\n\n   EDRIXS: An open source toolkit for simulating spectra of resonant inelastic x-ray scattering\n   Y.L. Wang, G. Fabbris, M.P.M. Dean and G. Kotliar, arXiv:1812.05735. Accepted as publication in CPC.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/NSLS-II/edrixs",
        "keywords": "",
        "license": "BSD (3-clause)",
        "maintainer": "",
        "maintainer_email": "",
        "name": "edrixs",
        "package_url": "https://pypi.org/project/edrixs/",
        "platform": "",
        "project_url": "https://pypi.org/project/edrixs/",
        "project_urls": {
            "Homepage": "https://github.com/NSLS-II/edrixs"
        },
        "release_url": "https://pypi.org/project/edrixs/0.0.4/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "An open source toolkit for simulating RIXS spectra based on ED",
        "version": "0.0.4"
    },
    "last_serial": 5472966,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "860805e253ac142af48b180b63735152",
                    "sha256": "89c627b16f7d06f78665412ea1a55d745bcfd61902616d22854f7fa02e92630e"
                },
                "downloads": -1,
                "filename": "edrixs-0.0.1-cp36-cp36m-manylinux1_x86_64.whl",
                "has_sig": false,
                "md5_digest": "860805e253ac142af48b180b63735152",
                "packagetype": "bdist_wheel",
                "python_version": "cp36",
                "requires_python": null,
                "size": 175955,
                "upload_time": "2019-05-15T21:15:01",
                "url": "https://files.pythonhosted.org/packages/cc/d0/56fa7f8dfa3db5a3197c633e38cfe17291fc1f997d29bb88951ec242edd2/edrixs-0.0.1-cp36-cp36m-manylinux1_x86_64.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "9044d59c80dd7311db9542fe3aa90015",
                    "sha256": "9813f07fd9be08f91925e00ca93723926e295d62d0f59ead8c492ecd3010d513"
                },
                "downloads": -1,
                "filename": "edrixs-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "9044d59c80dd7311db9542fe3aa90015",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 87657,
                "upload_time": "2019-05-15T21:15:03",
                "url": "https://files.pythonhosted.org/packages/ed/8f/b612e41f875dfb1c3cd460c38565612130e68275c67ea306b0cd598b4b24/edrixs-0.0.1.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5361e01ba466b70d85e95a00e0c96510",
                    "sha256": "3ece306316dbbe1fc46fe3961339115c04c0c6ecaadb82460de77df53dc5b9dc"
                },
                "downloads": -1,
                "filename": "edrixs-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "5361e01ba466b70d85e95a00e0c96510",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 90861,
                "upload_time": "2019-06-28T18:42:21",
                "url": "https://files.pythonhosted.org/packages/ef/cb/aab4dc7ace4365f5e254e0987c9a0e2dc2fee01cd2af9b5139c7f164d2ff/edrixs-0.0.3.tar.gz"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a7d95a7395dd65541267e5d911f37426",
                    "sha256": "4d2f0757406dd01197925586db6a9363e2f3945f208fae5dc98e947139d8df9e"
                },
                "downloads": -1,
                "filename": "edrixs-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "a7d95a7395dd65541267e5d911f37426",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 110610,
                "upload_time": "2019-07-01T19:08:28",
                "url": "https://files.pythonhosted.org/packages/58/c6/ff0b45b8b2600746810994872160e9008527ee0c30d23c95a80ba21b9ec3/edrixs-0.0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a7d95a7395dd65541267e5d911f37426",
                "sha256": "4d2f0757406dd01197925586db6a9363e2f3945f208fae5dc98e947139d8df9e"
            },
            "downloads": -1,
            "filename": "edrixs-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "a7d95a7395dd65541267e5d911f37426",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 110610,
            "upload_time": "2019-07-01T19:08:28",
            "url": "https://files.pythonhosted.org/packages/58/c6/ff0b45b8b2600746810994872160e9008527ee0c30d23c95a80ba21b9ec3/edrixs-0.0.4.tar.gz"
        }
    ]
}