shorten name to blop

.cookiecutter-bloptools.yaml

@@ -2,10 +2,10 @@ default_context:
   full_name: "Brookhaven National Laboratory"
   email: "mrakitin@bnl.gov"
   github_username: "NSLS-II"
-  project_name: "bloptools"
-  package_dist_name: "bloptools"
-  package_dir_name: "bloptools"
-  repo_name: "bloptools"
+  project_name: "blop"
+  package_dist_name: "blop"
+  package_dir_name: "blop"
+  repo_name: "blop"
   project_short_description: "Beamline Optimization Tools"
   minimum_supported_python_version: "3.8"
 replay_dir: "~/tmp/new-repo"

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 source =
-    bloptools
+    blop
 [report]
 omit =
     */python?.?/*

.flake8

@@ -2,12 +2,12 @@
 exclude =
     .git,
     __pycache__,
-    bloptools/_version.py,
+    blop/_version.py,
     build,
     dist,
     docs/source/conf.py
     examples/*.py,
-    bloptools/tests/test_bayesian_shadow.py,
+    blop/tests/test_bayesian_shadow.py,
     versioneer.py,
 max-line-length = 125
 # Ignore some style 'errors' produced while formatting by 'black'

.gitattributes

@@ -1 +1 @@
-bloptools/_version.py export-subst
+blop/_version.py export-subst

CONTRIBUTING.rst

@@ -13,7 +13,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/NSLS-II/bloptools/issues.
+Report bugs at https://github.com/NSLS-II/blop/issues.
 
 If you are reporting a bug, please include:
 
@@ -35,14 +35,14 @@ is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-bloptools could always use more documentation, whether
-as part of the official bloptools docs, in docstrings,
+blop could always use more documentation, whether
+as part of the official blop docs, in docstrings,
 or even on the web in blog posts, articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/NSLS-II/bloptools/issues.
+The best way to send feedback is to file an issue at https://github.com/NSLS-II/blop/issues.
 
 If you are proposing a feature:
 
@@ -54,17 +54,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `bloptools` for local development.
+Ready to contribute? Here's how to set up `blop` for local development.
 
-1. Fork the `bloptools` repo on GitHub.
+1. Fork the `blop` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/bloptools.git
+    $ git clone git@github.com:your_name_here/blop.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv bloptools
-    $ cd bloptools/
+    $ mkvirtualenv blop
+    $ cd blop/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -75,7 +75,7 @@ Ready to contribute? Here's how to set up `bloptools` for local development.
 
 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
 
-    $ flake8 bloptools tests
+    $ flake8 blop tests
     $ python setup.py test
     $ tox
 
@@ -99,5 +99,5 @@ Before you submit a pull request, check that it meets these guidelines:
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
 3. The pull request should work for Python 2.7, 3.3, 3.4, 3.5 and for PyPy. Check
-   https://travis-ci.org/NSLS-II/bloptools/pull_requests
+   https://travis-ci.org/NSLS-II/blop/pull_requests
    and make sure that the tests pass for all supported Python versions.

MANIFEST.in

@@ -10,8 +10,8 @@ recursive-exclude * *.py[co]
 recursive-include docs *.rst conf.py Makefile make.bat
 
 include versioneer.py
-include bloptools/_version.py
-include bloptools/bayesian/acquisition/config.yml
+include blop/_version.py
+include blop/bayesian/acquisition/config.yml
 
 # If including data files in the package, add them like:
 # include path/to/data_file

README.rst

@@ -1,16 +1,16 @@
 =========
-bloptools
+blop
 =========
 
-.. image:: https://github.com/NSLS-II/bloptools/actions/workflows/testing.yml/badge.svg
-   :target: https://github.com/NSLS-II/bloptools/actions/workflows/testing.yml
+.. image:: https://github.com/NSLS-II/blop/actions/workflows/testing.yml/badge.svg
+   :target: https://github.com/NSLS-II/blop/actions/workflows/testing.yml
 
 
-.. image:: https://img.shields.io/pypi/v/bloptools.svg
-        :target: https://pypi.python.org/pypi/bloptools
+.. image:: https://img.shields.io/pypi/v/blop.svg
+        :target: https://pypi.python.org/pypi/blop
 
 
 Beamline Optimization Tools
 
 * Free software: 3-clause BSD license
-* Documentation: https://NSLS-II.github.io/bloptools.
+* Documentation: https://NSLS-II.github.io/blop.

bloptools/_version.py

@@ -22,9 +22,9 @@ def get_keywords():
     # setup.py/versioneer.py will grep for the variable names, so they must
     # each be defined on a line of their own. _version.py will just call
     # get_keywords().
-    git_refnames = "$Format:%d$"
-    git_full = "$Format:%H$"
-    git_date = "$Format:%ci$"
+    git_refnames = " (HEAD -> main)"
+    git_full = "a09f82569e91255c8591efce18ff684aae682970"
+    git_date = "2024-01-06 19:41:45 -0500"
     keywords = {"refnames": git_refnames, "full": git_full, "date": git_date}
     return keywords
 
@@ -42,7 +42,7 @@ def get_config():
     cfg.style = "pep440-post"
     cfg.tag_prefix = "v"
     cfg.parentdir_prefix = "None"
-    cfg.versionfile_source = "bloptools/_version.py"
+    cfg.versionfile_source = "blop/_version.py"
     cfg.verbose = False
     return cfg
 

bloptools/experiments/nsls2/iss.py

@@ -2,7 +2,7 @@
 import bluesky.plans as bp
 import numpy as np
 
-from bloptools.tasks import Task
+from blop.tasks import Task
 
 
 def initialize():

bloptools/tests/conftest.py

@@ -8,9 +8,9 @@
 from databroker import Broker
 from ophyd.utils import make_dir_tree
 
-from bloptools.bayesian import DOF, Agent, Objective
-from bloptools.bayesian.dofs import BrownianMotion
-from bloptools.utils import functions
+from blop.bayesian import DOF, Agent, Objective
+from blop.bayesian.dofs import BrownianMotion
+from blop.utils import functions
 
 
 @pytest.fixture(scope="function")

docs/source/conf.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# bloptools documentation build configuration file, created by
+# blop documentation build configuration file, created by
 # sphinx-quickstart on Thu Jun 28 12:35:56 2018.
 #
 # This file is execfile()d with the current directory set to its
@@ -68,20 +68,20 @@
 master_doc = "index"
 
 # General information about the project.
-project = "bloptools"
+project = "blop"
 copyright = "2020, Brookhaven National Laboratory"
 author = "Brookhaven National Laboratory"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-import bloptools
+import blop
 
 # The short X.Y version.
-version = bloptools.__version__
+version = blop.__version__
 # The full version, including alpha/beta/rc tags.
-release = bloptools.__version__
+release = blop.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -127,7 +127,7 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "bloptools"
+htmlhelp_basename = "blop"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -152,8 +152,8 @@
 latex_documents = [
     (
         master_doc,
-        "bloptools.tex",
-        "bloptools Documentation",
+        "blop.tex",
+        "blop Documentation",
         "Contributors",
         "manual",
     ),
@@ -167,8 +167,8 @@
 man_pages = [
     (
         master_doc,
-        "bloptools",
-        "bloptools Documentation",
+        "blop",
+        "blop Documentation",
         [author],
         1,
     )
@@ -183,10 +183,10 @@
 texinfo_documents = [
     (
         master_doc,
-        "bloptools",
-        "bloptools Documentation",
+        "blop",
+        "blop Documentation",
         author,
-        "bloptools",
+        "blop",
         "Beamline Optimization Tools",
         "Miscellaneous",
     ),

docs/source/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-bloptools Documentation
+blop Documentation
 =======================
 
 .. toctree::

docs/source/installation.rst

@@ -11,13 +11,13 @@ To install the package using the ``pip`` package manager, run the following comm
 
 .. code:: bash
 
-   $ python3 -m pip install bloptools
+   $ python3 -m pip install blop
 
 To install the package using the ``conda`` package manager, run the following command:
 
 .. code:: bash
 
-   $ conda install -c conda-forge bloptools
+   $ conda install -c conda-forge blop
 
 If you'd like to use the Sirepo backend and ``sirepo-bluesky`` ophyd objects, please
 follow the `Sirepo/Sirepo-Bluesky installation & configuration instructions

docs/source/tutorials/himmelblau.ipynb

@@ -16,7 +16,7 @@
    "id": "c18ef717",
    "metadata": {},
    "source": [
-    "Let's use ``bloptools`` to minimize Himmelblau's function, which has four global minima:"
+    "Let's use ``blop`` to minimize Himmelblau's function, which has four global minima:"
    ]
   },
   {
@@ -26,7 +26,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from bloptools.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp"
    ]
@@ -41,7 +41,7 @@
     "import numpy as np\n",
     "import matplotlib as mpl\n",
     "from matplotlib import pyplot as plt\n",
-    "from bloptools.utils import functions\n",
+    "from blop.utils import functions\n",
     "\n",
     "x1 = x2 = np.linspace(-6, 6, 256)\n",
     "X1, X2 = np.meshgrid(x1, x2)\n",
@@ -69,7 +69,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from bloptools.bayesian import DOF\n",
+    "from blop.bayesian import DOF\n",
     "\n",
     "dofs = [\n",
     "    DOF(name=\"x1\", limits=(-6, 6)),\n",
@@ -92,7 +92,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from bloptools.bayesian import Objective\n",
+    "from blop.bayesian import Objective\n",
     "\n",
     "objectives = [Objective(name=\"himmelblau\", description=\"Himmeblau's function\", target=\"min\")]"
    ]
@@ -140,7 +140,7 @@
    },
    "outputs": [],
    "source": [
-    "from bloptools.bayesian import Agent\n",
+    "from blop.bayesian import Agent\n",
     "\n",
     "\n",
     "agent = Agent(\n",

docs/source/tutorials/hyperparameters.ipynb

@@ -21,7 +21,7 @@
     "import numpy as np\n",
     "import matplotlib as mpl\n",
     "from matplotlib import pyplot as plt\n",
-    "from bloptools.utils import functions\n",
+    "from blop.utils import functions\n",
     "\n",
     "x1 = x2 = np.linspace(-10, 10, 256)\n",
     "X1, X2 = np.meshgrid(x1, x2)\n",
@@ -68,11 +68,11 @@
    },
    "outputs": [],
    "source": [
-    "from bloptools.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp\n",
     "\n",
-    "from bloptools.bayesian import DOF, Objective, Agent\n",
+    "from blop.bayesian import DOF, Objective, Agent\n",
     "\n",
     "dofs = [\n",
     "    DOF(name=\"x1\", limits=(-6, 6)),\n",

docs/source/tutorials/passive-dofs.ipynb

@@ -26,7 +26,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from bloptools.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp"
    ]
@@ -38,8 +38,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from bloptools.utils import functions\n",
-    "from bloptools.bayesian import DOF, Agent, BrownianMotion, Objective\n",
+    "from blop.utils import functions\n",
+    "from blop.bayesian import DOF, Agent, BrownianMotion, Objective\n",
     "\n",
     "\n",
     "dofs = [\n",

docs/source/usage.rst

@@ -89,9 +89,9 @@ Combining these with a databroker instance will construct an agent.
 
 .. code-block:: python
 
-    import bloptools
+    import blop
 
-    my_agent = bloptools.bayesian.Agent(
+    my_agent = blop.bayesian.Agent(
         dofs=my_dofs,
         dets=my_dets,
         tasks=my_tasks,