craceplot 0.1.0__py3-none-any.whl

craceplot-0.1.0.dist-info/METADATA

@@ -0,0 +1,369 @@
+Metadata-Version: 2.4
+Name: craceplot
+Version: 0.1.0
+Summary: craceplot: Visualisation of Data from crace
+Author: Yunshuang Xiao
+Maintainer-email: crace developers <race.autoconfig@gmail.com>, Yunshuang Xiao <yunshuang.xiao@ulb.be>
+License-Expression: MIT
+Project-URL: Homepage, https://race-autoconfig.github.io/craceplot/
+Project-URL: Source, https://github.com/race-autoconfig/craceplot/
+Project-URL: Tracker, https://github.com/race-autoconfig/craceplot/issues
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pandas>=1.0.5
+Dynamic: license-file
+
+**craceplot**: Visualisation of Data from crace
+===========================================
+
+<!-- badge start -->
+[![PyPI](https://img.shields.io/pypi/v/craceplot?cacheSeconds=3600)][craceplot-pycode]
+[![Python](https://img.shields.io/pypi/pyversions/craceplot?cacheSeconds=3600)][craceplot-pycode]
+[![Docs](https://img.shields.io/badge/docs-online-blue?cacheSeconds=3600)][craceplot-homepage]
+[![License](https://img.shields.io/github/license/race-autoconfig/craceplot?cacheSeconds=3600)](docs/references/license.md)
+<!-- badge end -->
+
+<!-- link start -->
+[ [**Homepage**][craceplot-homepage] ] [
+[**Source Code**][craceplot-src] ] [
+[**User Guide**][craceplot-guide] ] [
+[**Report A Bug**](https://github.com/race-autoconfig/craceplot/issues) ] [
+[**Discussions**](https://github.com/race-autoconfig/craceplot/discussions) ]
+<!-- link end -->
+
+
+<!-- authors -->
+**Authors:** Yunshuang Xiao [![ORCID][orcid-icon]](https://orcid.org/0009-0003-6752-8627).
+
+**Contact**: crace developers [race.autoconfig@gmail.com](mailto:race.autoconfig@gmail.com)
+
+
+<!-- literature -->
+**Relevant literature:**
+
+-  Yunshuang Xiao, Leslie Pérez Cáceres, Manuel López-Ibáñez, and Thomas Stützle. 
+   [**Algorithm Configuration via Continuously Racing: Preliminary Results**](
+    https://doi.org/10.1145/3583133.3596408). *In Proceedings 
+   of the Companion Conference on Genetic and Evolutionary Computation (GECCO '23 Companion
+   )*. Association for Computing Machinery, New York, NY, USA, 1744–1752. 
+   doi: 10.1145/3583133.3596408
+
+
+# Introduction
+
+**craceplot** provides a set of functions to create plots to visualize the 
+data generated by the crace software for automatic algorithm configuration 
+(hyper-parameter optimization).
+
+This package provides visualizations for:
+
+- Parameter configurations using parallel coordinates with param_parallelcoord( ) 
+  or param_parallelcat( ).
+
+- Configurations performance (training and testing) with qual_boxplot( ), 
+  qual_heatmap( ) and qual_scatter( ).
+
+- Sampling distributions with param_boxplot( ), param_histplot( ), param_pairplot( ), 
+  param_heatmap( ), param_jointplot( ) and param_sunburst( ).
+
+For more details about these functions, please check the user guide of the package 
+and the documentation of the functions implemented in the package.
+
+The aim of this package is to provide support for the analysis of the single crace 
+run and its best parameter settings found, the assessment of the parameter space 
+explored by crace and the overall performance of the configuration process. 
+
+**Keywords**: automatic configuration, offline tuning, parameter tuning, parameter 
+visualization, crace.
+
+
+
+## Requisites
+
+Python ($\text{version} \geq 3.8.0$) is required for running craceplot, but you don't need to 
+know the Python language to use it. Python is freely available and you can download it 
+from the [Python project website](https://www.python.org/). See [Quick Start](#quick-start) 
+for a quick installation guide of Python.
+
+
+## User guide
+
+
+A complete user guide comes with a IPython Notebook file.
+You can access it online [guide][craceplot-guide] or, after installing the craceplot package,
+invoking from the terminal console using the following command:
+``` bash
+craceplot doc
+```
+
+The following is a quick-start guide. The user guide gives more detailed instructions.
+
+# Quick Start
+
+-  Install Python (with your favorite package manager, and see more details below).
+-  Install crace. The crace package can be installed automatically with conda, with pip 
+    or from the source code. We advise to use the automatic installation unless particular 
+    circumstances do not allow it. 
+-  Once crace is installed, three commands, `crace`, `crace_mpi` and `crace_guide`, 
+    will be added to the active environment. These commands work in Bash shell (Linux and 
+    MacOS) as well as in Powershell (Windows).
+-  You can open the user guide with the following command. This command
+    works on Bash shell (Linux and MacOS) and Powershell (Windows)
+    with the active environment added to PATH (see detailed instructions below).
+
+## Installing Python
+
+This section gives a quick Python installation guide that will work in most cases. 
+The official instructions are available at [official python site](
+    https://www.python.org/about/gettingstarted/). 
+
+### GNU/Linux
+
+You should install Python from your package manager. On a Debian/Ubuntu system 
+it will be something like
+
+```bash
+sudo apt-get install python3 python3-dev
+```
+
+Once Python is installed, you can use conda, pip or the source code to install 
+the crace package. See instructions below.
+
+### OS X
+
+For macOS 10.9 (Jaguar) up until 12.3 (Catalina) the operating system includes 
+Python 2, which is no longer supported and is not a good choice for development. 
+You should go to do the [downloads page](https://www.python.org/downloads/) and 
+download the installer.
+
+For newer versions of macOS, Python is no longer included by default and you 
+will have to download and install it. You can refer to the [Python documentation](
+    https://docs.python.org/3/using/mac.html) for more details on the 
+    installation process and getting started.
+
+You can install Python directly from a PyPI mirror (https://pypi.org/). 
+Alternatively, you can just brew the Python formula from the science 
+tap (unfortunately it does not come already bottled so you need to have Xcode 
+(https://developer.apple.com/xcode/download/) installed to compile it):
+
+```bash
+# install homebrew if you don’t have it
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+# install python 3
+brew tap homebrew/science
+brew install python
+```
+
+Once Python is installed, you can use conda, pip or the source code to
+install the craceplot package.
+
+### Windows
+
+You can install Python from the official website (https://www.python.org/downloads/windows).
+We recommend that you install Python on a filesystem path without spaces, special characters or long
+names, such as `C:\Python`.
+
+> Note that Python 3.5 - 3.8 cannot be used on Windows XP or earlier and Python 3.9 - 3.13 cannot be used on Windows 7 or earlier.  
+
+
+Once Python is installed, you can use conda, pip or the source code to
+install the craceplot package.
+
+
+
+
+## Installing craceplot
+
+### Requirements
+- Python (>= 3.6.0) is required for running craceplot package. 
+- crace (>= 0.0.0) is required for running craceplot package, and you must have
+  completed log files from one crace run in advance. See
+  [crace user guide](https://race-autoconfig.github.io/crace/crace-package.pdf) for installing crace and
+  obtaining log files.
+
+The craceplot package can be installed automatically with conda, with pip or from the source.
+We advise to use the automatic installation unless particular circumstances do not allow it. 
+The instructions to install craceplot with the three mentioned methods are the following:
+
+### Install automatically with conda
+
+If you use Conda, execute the following line at the shell to install the package:
+
+```bash
+# Use the environment where you install crace
+conda activate my-env
+# If you want to install from conda-forge
+conda config --env --add channels conda-forge
+# The actual install command
+conda install craceplot
+```
+
+Alternatively, within the Conda graphical interface (Anaconda Navigator), you may search and install craceplot.
+
+### Install automatically with pip
+
+If you use Pip, execute the following line at the shell to install the package:
+```bash
+pip3 install craceplot
+```
+
+Also when using pip, it's good practice to use a virtual environment and here is the [guide](https://dev.to/bowmanjd/python-tools-for-managing-virtual-environments-3bko#howto) for using the virtual environment.
+
+
+### Manual download and installation from source
+
+If the previous installation instructions fail because of insufficient
+permissions and you do not have sufficient admin rights to install craceplot
+system-wide, then you need to force a local installation. 
+From the craceplot package [PyPI website][craceplot-pycode], search and download one of the 
+two available versions depending on your operating system:
+
+- `craceplot-xxx.tar.gz` (Unix/Linux/BSD/macOS)
+- `craceplot-xxx-py3-none-any.whl` (python3, any platform)
+
+
+Alternatively, you can use wget or curl from the command line to download the file: 
+```bash
+# PyPI
+wget https://files.pythonhosted.org/packages/source/c/craceplot/craceplot-xxx.tar.gz
+# Github
+wget https://github.com/race-autoconfig/craceplot/
+```
+
+To install the package on GNU/Linux, macOS or Windows using the formats .tar.gz,
+you should first extract the source files and then navigate to the directory 
+containing the extracted files and run the following command to install the package: 
+
+```bash
+python3 install .
+```
+
+To install the package on any platform using the Wheel format, you should run the following command to install the package:
+
+```bash
+pip3 install /path/to/craceplot-xxx-py3-none-any.whl
+```
+
+## Testing the installation and invoking craceplot
+
+Once craceplot has been installed, list by using command line at the shell 
+
+```bash
+# List installed packages at the shell
+pip3 list
+# Show the information of craceplot at the shell
+pip3 show craceplot
+```
+
+or load the package and test that the installation
+was successful by opening a Python console and executing:
+
+```python
+# Load and test at the Python console
+import craceplot
+print(craceplot.__version__)
+```
+
+
+### Checking the installation path of craceplot
+Once `craceplot` is installed, the executable command will be added to the environment. 
+To check the installation path of craceplot using command line at the shell:
+```bash
+which craceplot
+```
+
+The output of this line must be `$PYTHON_HOME/bin/craceplot`, which means
+the path before `/bin/craceplot` is `$PYTHON_HOME`.
+Here, `$CRACEPLOT_HOME` should be:
+```bash
+CRACEPLOT_HOME=$PYTHON_HOME/lib/python3.X/site-packages/craceplot
+```
+
+Also, you can check the installation path of craceplot opening a Python console and executing:
+```python
+import importlib.util
+print(importlib.util.find_spec('craceplot').submodule_search_locations)
+```
+
+This command must print out the filesystem path where craceplot is installed. 
+In the remainder of this guide, the variable `$CRACEPLOT_HOME` is used to
+denote this path. When executing any provided command that includes the 
+`$CRACEPLOT_HOME` variable, do not forget to replace it with the true
+installation path of **craceplot**.
+
+On GNU/Linux or macOS, you can let the operating system know where to find 
+**craceplot** by defining the `$PYTHON_HOME` variable and adding it to the system
+`PATH`. Append the following commands to `~/.bash_profile`, 
+`~/.bashrc` or `~/.profile`:
+```bash
+# Replace <CRACEPLOT_HOME> with the craceplot installation path
+export CRACEPLOT_HOME=<CRACEPLOT_HOME>
+# Tell operating system where to find craceplot
+export PATH=${PYTHON_HOME}/bin/:$PATH
+```
+
+Then, open a new terminal and launch craceplot as follows:
+
+```bash
+craceplot --help
+```
+
+Alternatively, you may directly invoke craceplot within the Python
+console by executing:
+```python
+import craceplot
+craceplot.run("--help")
+```
+
+# License
+
+
+craceplot is free software (software libre): you can redistribute it and/or 
+modify it under the terms of the MIT License.
+
+This program is distributed in the hope that it will be useful, but WITHOUT 
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
+FOR A PARTICULAR PURPOSE. 
+
+**IMPORTANT NOTE:** Please be aware that the fact that this program is released 
+as Free Software does not excuse you from scientific propriety, which obligates 
+you to give appropriate credit! If you write a scientific paper describing research that 
+made substantive use of this program, it is your obligation as a scientist to 
+(a) mention the fashion in which this software was used in the Methods section; 
+(b) mention the algorithm in the References section. 
+
+The appropriate citation is:
+- Yunshuang Xiao, Leslie Pérez Cáceres, Manuel López-Ibáñez, and Thomas Stützle. 2023. 
+  Algorithm Configuration via Continuously Racing: Preliminary Results. *In Proceedings 
+  of the Companion Conference on Genetic and Evolutionary Computation (GECCO '23 Companion
+  )*. Association for Computing Machinery, New York, NY, USA, 1744–1752. 
+  doi: [10.1145/3583133.3596408](https://doi.org/10.1145/3583133.3596408)
+
+
+craceplot is built as an additional tool for the crace package:
+  crace: Continuous Racing for Automatic Algorithm Configuration
+  Copyright (c) 2026 crace developers
+
+
+
+[craceplot-guide]: https://race-autoconfig.github.io/craceplot/guide.html
+[craceplot-homepage]: https://race-autoconfig.github.io/craceplot/
+[craceplot-src]: https://github.com/race-autoconfig/craceplot/
+[craceplot-pycode]: https://pypi.org/project/craceplot/
+[orcid-icon]: https://orcid.org/sites/default/files/images/orcid_16x16.png

craceplot-0.1.0.dist-info/RECORD

@@ -0,0 +1,61 @@
+craceplot/__init__.py,sha256=FN3_yxh6Kh9dSHbTzghz7SxtxTyDVeBvKZvn5ewREbY,1902
+craceplot/_vergit.py,sha256=QO1oEhsD3oR3AAMCvzT1M6F7Ho9wuCekfhIlNrZHURc,60
+craceplot/_version.py,sha256=bnR2Dr8wtAzTCLCtdvV6AcTwQHbOxxSe-wvdKucZ97Y,528
+craceplot/_containers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+craceplot/_containers/_core.py,sha256=HThSNOjlA2caUvlvjcCqHg9eySIlqErDNIzNO7_Z8FM,61402
+craceplot/_containers/_draw.py,sha256=1-GLozVvvN2ZwOgQjTronoDUXwEVh9Pm_C7A_BphP5k,3218
+craceplot/_inst/examples/acotsp/crace-3240078.stdout,sha256=ua4lXQbWqpkf_PuO205YAHv2LKjSU7UhOFqOq9QLW3w,69810
+craceplot/_inst/examples/acotsp/crace.stderr,sha256=TrV6vT3drmmedeQmec4aSuoU8Oy2GYGAdeRvQlrkLv8,399
+craceplot/_inst/examples/acotsp/crace.test,sha256=H7fuYgTmdfTqqJA96dAH7O1Z8k21mwIGmAnrwfTlSgg,20653
+craceplot/_inst/examples/acotsp/crace.train,sha256=SnRiWWyzUcbKDhMIdaIibCnVdcdIcSdghzQCGRt4-tk,49157
+craceplot/_inst/examples/cats200/crace-2814581.stdout,sha256=RDAnAjgb8mtmVfzIJGoXjNuZJz99mAgH7iev9EktLYU,170846
+craceplot/_inst/examples/cats200/crace.stderr,sha256=pAQy7tRfvRCBrPizZBS2xIvLk3s-EsnW_kHEoevn2bc,657
+craceplot/_inst/examples/cats200/crace.test,sha256=0tZbHSlj1x9mUl9b1ykXp8hYJE7l0CJ8Bt7JoljZuZ8,99909
+craceplot/_inst/examples/cats200/crace.train,sha256=Nk74LfJisKyEWh7f2wxhnaMTzQBD3HOS5MnZJFfy7eI,70937
+craceplot/_plots/__init__.py,sha256=zj6RzYCczkVri22MEfKFoUUWdbv37w-J8bJWMiHzGs0,191
+craceplot/_plots/_core.py,sha256=R7EV3N9MPaV8jtC9TtKm0fn--9eOUcwR6y2N9l60EE4,2589
+craceplot/_plots/parameters.py,sha256=pucWXwGbSjOKywy6tbVmgcxrlOoNHbxVDMhVA_WAZu0,65945
+craceplot/_plots/quality.py,sha256=X4kgxJiISvMJoeqOyysp7mV8n6X-NUudl8XG1M5sb0Y,52387
+craceplot/_scripts/__init__.py,sha256=Svn-yL_b7ZBglqA5W_D_evVFESwVyZGRYoY6xtWz9gg,125
+craceplot/_scripts/_main.py,sha256=Jl9LUc3Gpk4kLVQ1zb2fzV_ES64n6j7ucCBHS6FV7Yg,4196
+craceplot/_scripts/_utils.py,sha256=0G9aOIZJTcX6PlGnoLFoa1ptdFOO4NAP92n-ZNjxVSU,1754
+craceplot/_scripts/main,sha256=WWLPA27h_GDGkZrBykwy2R8yTBib2aOdYR0QTe5yF7s,120
+craceplot/_scripts/open_guide,sha256=VyVXVkA2l1sycYGjIKyXfW1KsJWu5MuWdV76du3VPYo,338
+craceplot/_settings/_description.py,sha256=lSpXFVsnwMR7H8W5ishXTZ1KvbBHQwZrbQcDdYOduSI,5833
+craceplot/_settings/_options.json,sha256=6FTCTBFUCXjKsAYrj3G1gVY3NT2hMTh5_d5ywP2oUuc,12157
+craceplot/_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+craceplot/_utils/_base.py,sha256=g6EeTLY_gXcp-EX5UxJ96pijuVZYt3muctjmzKmf_EA,5070
+craceplot/_utils/_const.py,sha256=vDTRDosC53d-03OLK6nDQLXmWPaQkdXwGgPES9rxdsQ,99
+craceplot/_utils/_crace.py,sha256=nZV7bqJA261Oaks7C44mpcRvuBauQMe8LAIB9kGphrw,1549
+craceplot/_utils/_format.py,sha256=QVp12QKAm1XM10qiRfwCBDDsFOco74taRDrBYheJJtM,5395
+craceplot/_vignettes/guide.ipynb,sha256=jilWhkZuOtsQ5qmFmITOm0d0kYa2ws-fQFveTJRAAOE,2241931
+craceplot-0.1.0.dist-info/licenses/LICENSE.md,sha256=3xZDHC6yc4wweo2BYQSgMIxC4Kx9ylmfPV7r4WsPKo0,1073
+docs/_config.yml,sha256=_AVJK-v2-SLS7nic79kFp3wzZ3pgQTtHLx1yBvrwzWs,1018
+docs/_toc.yml,sha256=-TxstNbpFJSWMAQYve-ycdEkTYcAb5v3hdPItzFhgoQ,92
+docs/index.md,sha256=kdHVA03RDCW0_urQi6uxbDPTLq8Fy45KHqrvsEUVFCg,74
+docs/requirements.txt,sha256=nTDDDuxbLldmeA8ReQaJcIAa4s-HRUXiArwaYPSPunM,97
+docs/_static/css/custom.css,sha256=92I37KQgdRALY9kv6mIeu_UTswbED5Vy-k6JnYoqVSI,3784
+docs/_static/js/navbar.js,sha256=o3bYmj-NBurelBZZw6mEQ6W4k0gZtmAdSs6zotEDWxk,1059
+docs/references/404.md,sha256=Yx9v62XVVnOv9booJuIYRVLa5jAVUJ6C3D1Kh0RKSZ8,210
+docs/references/authors.md,sha256=xU-SrQXr7a0gruDTiSnRjRD-zALOqmp2uI_1RfIpHOw,1867
+docs/references/citiation.bib,sha256=e4JNniX1DiX1_7RSWfdRGDMolabncCAwXGcg14oc8CQ,2136
+docs/references/index.md,sha256=L1Uq6kjQbOImlGPSi3ueEvzTxi4PuxoCisfSciyfviY,1424
+docs/references/license.md,sha256=NlGvScE1DVd-une2AD7GidFqyU0oAhdjgRUmFhXLFNg,1075
+docs/references/functions/index.md,sha256=B1p-OA_sAqXtWw3-P47kFD5fmnLlfDlMANw14ZhG6zY,147
+docs/references/functions/param_boxplot.ipynb,sha256=VO0HTIMYPAummJ1ktEZIp64E-ZkOuKspeRfuBbsBgNo,239
+docs/references/others/favicon.ico,sha256=t16XC3VU78E7dbqADhVTig3ZYWhMPGzBgw9lvcZOTQs,15406
+docs/references/others/logo.png,sha256=XCwP3fCdDqgDNZxVYe7uOsiI6AeccklEA2IaxxHe2LE,17162
+docs/references/others/logo1.png,sha256=Anq92k8zSoN3Y1aHQi2W168nueqAorVvXUFBgFEozXo,20355
+docs/references/others/favicon_io/about.txt,sha256=PLdVmi-4LXMEuJHVkD9_Ouv323UW8xpHFJ-AZW9y9kA,224
+docs/references/others/favicon_io/android-chrome-192x192.png,sha256=ICWt1YLUCe9S6qiSXAWTb_a2oD6SA-bm1fWgg8cx6a8,6378
+docs/references/others/favicon_io/android-chrome-512x512.png,sha256=Anq92k8zSoN3Y1aHQi2W168nueqAorVvXUFBgFEozXo,20355
+docs/references/others/favicon_io/apple-touch-icon.png,sha256=HpSW-ot_trMHHK0z9d3jomV06KV2uJI4vKpd486wpZc,5734
+docs/references/others/favicon_io/favicon-16x16.png,sha256=agrSawJdKBsK1qlNu0yjygRpi0vpaR7CWlfdJUMz6ik,456
+docs/references/others/favicon_io/favicon-32x32.png,sha256=5Lzld7L7-APBatUtE8PdpnkPCmEKAFd2JfkLx2GL3uc,862
+docs/references/others/favicon_io/site.webmanifest,sha256=ep4Hzh9zhmiZF2At3Fp1dQrYQuYF_3ZPZxc1KcGBvwQ,263
+docs/references/plots/acotsp-parallelcoord-all.png,sha256=CgBrY44tsE16tYFlLNsJU-c51CnKPZjQIjCwBqPJ2os,4399429
+craceplot-0.1.0.dist-info/METADATA,sha256=s_4YByg4UEP2ePwtmKJ40iQl8cS6lkVyTA4SdeS_OcU,14241
+craceplot-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+craceplot-0.1.0.dist-info/entry_points.txt,sha256=E6in5pU5dXZGpSgSUSM9ur4zRJmrfxzimLyJ0JziNSY,61
+craceplot-0.1.0.dist-info/top_level.txt,sha256=6dC2ePTDodODODTFJYA08EC8SCU_56Q12vu8Go9bBcM,15
+craceplot-0.1.0.dist-info/RECORD,,

craceplot-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

craceplot-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+craceplot = craceplot._scripts:start_cplot

craceplot-0.1.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2026 Yunshuang XIAO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

craceplot-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+craceplot
+docs

docs/_config.yml

@@ -0,0 +1,51 @@
+# Book settings
+title: craceplot
+authors: Yunshuang Xiao
+
+# Execution settings
+execute:
+  execute_notebooks: "off"
+
+# HTML settings
+html:
+  use_repository_button: true
+  use_issues_button: true
+  home_page_in_navbar: true
+
+# Repository information
+repository:
+  url: https://github.com/auto-configurator/craceplot
+  path_to_book: .
+  branch: main
+
+sphinx:
+  config:
+    project: "craceplot"
+
+    include_patterns:
+      - "**"
+      - "../README.md"
+
+    html_extra_path:
+      - '../craceplot/_vignettes/guide.ipynb'
+      - '../craceplot/_inst/examples'
+
+    html_context:
+      github_user: auto-configurator
+      github_repo: craceplot
+      github_version: main
+      doc_path: docs
+      # metatags: |
+      #   <meta name="google-site-verification" content="JOXRioKAur8pUUQhyzmuJqKs79IpGF4JPq09mDUt7W8" />
+
+    html_show_sourcelink: false
+
+    html_theme: piccolo_theme
+
+    html_static_path: ['_static']
+    html_css_files: [
+        'css/custom.css',
+    ]
+    html_js_files: [
+        'js/navbar.js',
+    ]

docs/_static/css/custom.css

@@ -0,0 +1,168 @@
+/* ===============================
+   Piccolo Dark Mode Code Styling
+   =============================== */
+
+/*****************************************************************************/
+/* fix top height */
+:root { --topnav-h: 64px; }
+
+/* remove top and margin */
+.document,
+.documentwrapper,
+.bodywrapper,
+.body {
+  margin-top: 0 !important;
+  padding-top: 0 !important;
+}
+
+/* set top height */
+.document {
+  margin-top: 0 !important;
+  padding-top: var(--topnav-h) !important;
+}
+
+
+/*****************************************************************************/
+/* Set body width */
+.documentwrapper {
+    width: 100% !important;
+    max-width: none !important;
+    margin: 0 auto !important;
+}
+.documentwrapper
+.bodywrapper {
+    width: 100% !important;
+    max-width: none !important;
+    min-width: 0 !important;
+    margin: 0 auto !important;
+}
+.documentwrapper
+.bodywrapper
+.body{
+    width: 95% !important;
+    margin: 0 auto !important;
+}
+
+
+/*****************************************************************************/
+/* Theme settings */
+/* set color for top nav */
+html #top_nav,
+html #top_nav nav {
+    background-color: #2c2c30 !important;
+}
+/* set color for search box */
+#searchbox form.search input[type=text] {
+  background-color: #ffffff;
+  color: #2c2c30;
+}
+#searchbox form.search input[type=text]::placeholder {
+  color: #bbbbbb;
+}
+#searchbox form.search input[type=submit] {
+  background-color: #ffffff;
+  color: #2c2c30;
+}
+
+/* LIGHT MODE */
+html[data-mode="light"] .highlight {
+    background-color: #f6f8fa !important;
+    border: 1px solid #e1e4e8 !important;
+}
+html[data-mode="light"] .highlight pre {
+    background-color: #f6f8fa !important;
+    color: #24292f !important;
+}
+html[data-mode="light"] code.literal {
+    background-color: #f3f4f6 !important;
+    color: #d14 !important;
+}
+html[data-mode="light"] .copybtn svg {
+    stroke: #57606a !important;
+}
+
+/* DARK MODE */
+html[data-mode="dark"] .highlight {
+    background-color: #1e1e1e !important;
+    border: 1px solid #2c2c2c !important;
+}
+html[data-mode="dark"] .highlight pre {
+    background-color: #1e1e1e !important;
+    color: #dddddd !important;
+}
+html[data-mode="dark"] code.literal {
+    background-color: #2a2a2a !important;
+    color: #ffcc66 !important;
+}
+html[data-mode="dark"] .copybtn svg {
+    stroke: #dddddd !important;
+}
+
+/* DARKEST MODE */
+html[data-mode="darkest"] .highlight {
+    background-color: #0d1117 !important;
+    border: 1px solid #30363d !important;
+}
+html[data-mode="darkest"] .highlight pre {
+    background-color: #0d1117 !important;
+    color: #c9d1d9 !important;
+}
+html[data-mode="darkest"] code.literal {
+    background-color: #161b22 !important;
+    color: #79c0ff !important;
+}
+html[data-mode="darkest"] .copybtn svg {
+    stroke: #c9d1d9 !important;
+}
+
+
+/*****************************************************************************/
+/* Setting width for 3-columns */
+:root {
+  --sidebar-right: clamp(8rem, 18vw, 30rem);
+  --sidebar-left: clamp(8rem, 12vw, 15rem);
+}
+/* Main content */
+div.document div.documentwrapper {
+  max-width: none;
+  width: 100%;
+}
+div.document {
+  margin-left: var(--sidebar-left);
+  margin-right: var(--sidebar-right);
+}
+@media (max-width: 50rem) {
+  div.document {
+    margin-left: 0px;
+    margin-right: 0px;
+  }
+}
+/* Sidebar */
+div.sphinxsidebar {
+  width: var(--sidebar-left);
+}
+@media (max-width: 50rem) {
+  div.sphinxsidebar {
+    display: none;
+  }
+}
+/* Right sidebar */
+div#right_sidebar {
+  width: var(--sidebar-right);
+}
+@media (max-width: 50rem) {
+  div#right_sidebar {
+    display: none;
+  }
+}
+/* Buttons */
+div.button_nav_wrapper {
+  margin-left: var(--sidebar-left);
+  margin-right: var(--sidebar-right);
+}
+@media (max-width: 50rem) {
+  div.button_nav_wrapper {
+    margin-left: 0px;
+    margin-right: 0px;
+  }
+}