{ "info": { "author": "Jaroslav Fowkes and Lindon Roberts", "author_email": "jaroslav.fowkes@maths.ox.ac.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Framework :: IPython", "Framework :: Jupyter", "Intended Audience :: Science/Research", "License :: OSI Approved :: GNU General Public License (GPL)", "Operating System :: MacOS", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering", "Topic :: Scientific/Engineering :: Mathematics" ], "description": "================================================================================================================\nPyCUTEst: A Python interface to the CUTEst Optimization Test Environment |License| |Build Status| |PyPI Version|\n================================================================================================================\n\nPyCUTEst is a Python interface to `CUTEst `_, a Fortran package for testing optimization software. It is based on the `interface originally developed for CUTEr `_ by `Prof. Arpad Buermen `_.\n\nFull details on how to use PyCUTEst are available in the `documentation `_.\n\nRequirements\n------------\nPyCUTEst requires the following software to be installed:\n\n* Python 2.7 or Python 3 (http://www.python.org/)\n* CUTEst (see below)\n\nAdditionally, the following python packages should be installed (these will be installed automatically if using *pip*, see `Installation using pip`_):\n\n* NumPy 1.11 or higher (http://www.numpy.org/)\n* SciPy 0.18 or higher (http://www.scipy.org/)\n\n**Please Note:** Currently PyCUTEst only supports Mac and Linux. For Windows 10 users, PyCUTEst can be used through the `Windows Subsystem for Linux `_, following the Linux installation instructions.\n\nInstalling CUTEst on Linux\n--------------------------\nThese instructions do not include installation of the MATLAB interface. You will need to install four packages: archdefs, SIFDecode, CUTEst and MASTSIF. To keep things simple, install all four packages in the same directory:\n\n .. code-block:: bash\n\n $ mkdir cutest\n $ cd cutest\n $ git clone https://github.com/ralna/ARCHDefs ./archdefs\n $ git clone https://github.com/ralna/SIFDecode ./sifdecode\n $ git clone https://github.com/ralna/CUTEst ./cutest\n $ git clone https://bitbucket.org/optrove/sif ./mastsif\n\nNote that :code:`mastsif` contains all the test problem definitions and \nis therefore quite large. If you're short on space you may want to copy \nonly the ``*.SIF`` files for the problems you wish to test on.\n\nNext set the following environment variables in your :code:`~/.bashrc` to point to the installation directories used above:\n\n .. code-block:: bash\n\n # CUTEst\n export ARCHDEFS=/path/to/cutest/archdefs/\n export SIFDECODE=/path/to/cutest/sifdecode/\n export MASTSIF=/path/to/cutest/mastsif/\n export CUTEST=/path/to/cutest/cutest/\n export MYARCH=\"pc64.lnx.gfo\"\n\nNow we are ready to install CUTEst in double precision (requires :code:`gfortran` and :code:`gcc`):\n\n .. code-block:: bash\n\n $ cd ./cutest\n $ ${ARCHDEFS}/install_optrove\n Do you wish to install GALAHAD (Y/n)? N\n Do you wish to install CUTEst (Y/n)? Y\n Do you require the CUTEst-Matlab interface (y/N)? N\n Select platform: 6 # PC with generic 64-bit processor\n Select operating system: 3 # Linux\n Would you like to review and modify the system commands (y/N)? N\n Select fortran compiler: 5 # GNU gfortran compiler\n Would you like to review and modify the fortran compiler settings (y/N)? N\n Select C compiler: 2 # generic GCC\n Would you like to review and modify the C compiler settings (y/N)? N\n Would you like to compile SIFDecode (Y/n)? Y\n Would you like to compile CUTEst (Y/n)? Y\n CUTEst may be compiled in (S)ingle or (D)ouble precision or (B)oth.\n Which precision do you require for the installed subset (D/s/b) ? D\n\nAnd CUTEst should run from here. To test that the installation works, issue the commands:\n\n .. code-block:: bash\n\n $ cd $SIFDECODE/src ; make -f $SIFDECODE/makefiles/$MYARCH test\n $ cd $CUTEST/src ; make -f $CUTEST/makefiles/$MYARCH test\n\n**Please Note:** *currently PyCUTEst only supports gfortran and uses the default version on your path (as returned by* :code:`gfortran -v` *). Please ensure this is the same version that you install CUTEst with above, this should be the case if you select the generic* :code:`GNU gfortran compiler` *as the fortran compiler in the installer above.*\n\nInstalling CUTEst on Mac\n------------------------\nFor simplicity, we recommend installing CUTEst using Homebrew as detailed below (but you can also install CUTEst manually by following the Linux installation instructions above). First it is important to ensure that you have the latest version of Xcode Command Line Tools installed (or the latest version of Xcode), please ensure this is the case by following `this guide `__. Now install the Homebrew package manager:\n\n .. code-block:: bash\n\n $ /usr/bin/ruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"\n\nThen you can easily install CUTEst:\n\n .. code-block:: bash\n\n $ brew tap optimizers/cutest\n $ brew install cutest --without-single --with-matlab # if using Matlab interface\n $ brew install mastsif # if you want all the test problems\n $ for f in \"archdefs\" \"mastsif\" \"sifdecode\" \"cutest\"; do \\\n $ echo \". $(brew --prefix $f)/$f.bashrc\" >> ~/.bashrc; \\\n $ done\n\nInstallation using pip\n----------------------\nFor easy installation, use `pip `_ as root:\n\n .. code-block:: bash\n \n $ [sudo] pip install pycutest\n\nor alternatively *easy_install*:\n\n .. code-block:: bash\n \n $ [sudo] easy_install pycutest\n\nIf you do not have root privileges or you want to install PyCUTEst for your private use, you can use:\n\n .. code-block:: bash\n \n $ pip install --user pycutest\n\nwhich will install PyCUTEst in your home directory.\n\nNote that if an older install of PyCUTEst is present on your system you can use:\n\n .. code-block:: bash\n\n $ [sudo] pip install --upgrade pycutest\n\nto upgrade PyCUTEst to the latest version.\n\nYou will then need to create a folder which will store all your compiled problems:\n\n .. code-block:: bash\n\n $ mkdir pycutest_cache\n\nAnd set an environment variable to tell PyCUTEst about this directory, by adding to your :code:`~/.bashrc` file:\n\n .. code-block:: bash\n\n export PYCUTEST_CACHE=\"/path/to/pycutest_cache\"\n export PYTHONPATH=\"${PYCUTEST_CACHE}:${PYTHONPATH}\"\n \n\nManual installation\n-------------------\nAlternatively, you can download the source code from `Github `_ and unpack as follows:\n\n .. code-block:: bash\n\n $ git clone https://github.com/jfowkes/pycutest\n $ cd pycutest\n\nPyCUTEst is written in pure Python and requires no compilation. It can be installed using:\n\n .. code-block:: bash\n\n $ [sudo] pip install .\n\nIf you do not have root privileges or you want to install PyCUTEst for your private use, you can use:\n\n .. code-block:: bash\n\n $ pip install --user .\n\nwhich will install PyCUTEst in your home directory.\n\nDon't forget to set up your cache and associated environment variable (see above).\n\nTo upgrade PyCUTEst to the latest version, navigate to the top-level directory (i.e. the one containing :code:`setup.py`) and rerun the installation using :code:`pip`, as above:\n\n .. code-block:: bash\n\n $ git pull\n $ [sudo] pip install . # with root privileges\n\nTesting\n-------\nIf you installed PyCUTEst manually, you can test your installation by running:\n\n .. code-block:: bash\n\n $ python setup.py test\n\nUninstallation\n--------------\nIf PyCUTEst was installed using *pip* you can uninstall as follows:\n\n .. code-block:: bash\n\n $ [sudo] pip uninstall pycutest\n\notherwise you have to remove the installed files by hand (located in your python site-packages directory).\n\nBugs\n----\nPlease report any bugs using GitHub's issue tracker.\n\nLicense\n-------\nThis algorithm is released under the GNU GPL license.\n\n.. |License| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg\n :target: https://www.gnu.org/licenses/gpl-3.0\n :alt: GNU GPL v3 License\n.. |Build Status| image:: https://travis-ci.org/jfowkes/pycutest.svg?branch=master\n :target: https://travis-ci.org/jfowkes/pycutest\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/pycutest.svg\n :target: https://pypi.python.org/pypi/pycutest", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jfowkes/pycutest/", "keywords": "mathematics optimization", "license": "GNU GPL", "maintainer": "", "maintainer_email": "", "name": "pycutest", "package_url": "https://pypi.org/project/pycutest/", "platform": "", "project_url": "https://pypi.org/project/pycutest/", "project_urls": { "Homepage": "https://github.com/jfowkes/pycutest/" }, "release_url": "https://pypi.org/project/pycutest/0.2/", "requires_dist": null, "requires_python": "", "summary": "A Python wrapper to the CUTEst optimization test environment", "version": "0.2" }, "last_serial": 5367232, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "21dde811d74d46053891d6fab1d6aaed", "sha256": "8fc519ddfa374de85f2a72a970c6e784c194e676bf5029f165f1ae1a38185aad" }, "downloads": -1, "filename": "pycutest-0.1.tar.gz", "has_sig": false, "md5_digest": "21dde811d74d46053891d6fab1d6aaed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34361, "upload_time": "2018-09-06T11:52:33", "url": "https://files.pythonhosted.org/packages/1e/fe/c512e47b8a494b6a68fff561b5f81277e384f24ecb826084f883b10ee556/pycutest-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "a6a32d871aa251c4e7b0026d48c5b645", "sha256": "ae8fdea178c62b116a04baa5da6f21d8cea41bf7a1d8878a9f0fd3c0c7101734" }, "downloads": -1, "filename": "pycutest-0.2.tar.gz", "has_sig": false, "md5_digest": "a6a32d871aa251c4e7b0026d48c5b645", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 36354, "upload_time": "2019-06-06T13:38:16", "url": "https://files.pythonhosted.org/packages/2a/87/bfd5d0d2692fb346cfcf805172be3b57a1056f510317412a78dec15285f6/pycutest-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a6a32d871aa251c4e7b0026d48c5b645", "sha256": "ae8fdea178c62b116a04baa5da6f21d8cea41bf7a1d8878a9f0fd3c0c7101734" }, "downloads": -1, "filename": "pycutest-0.2.tar.gz", "has_sig": false, "md5_digest": "a6a32d871aa251c4e7b0026d48c5b645", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 36354, "upload_time": "2019-06-06T13:38:16", "url": "https://files.pythonhosted.org/packages/2a/87/bfd5d0d2692fb346cfcf805172be3b57a1056f510317412a78dec15285f6/pycutest-0.2.tar.gz" } ] }