calkit-python 0.3.1__tar.gz → 0.3.3__tar.gz

{calkit_python-0.3.1 → calkit_python-0.3.3}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: calkit-python
-Version: 0.3.1
+Version: 0.3.3
 Summary: Reproducibility simplified.
 Project-URL: Homepage, https://github.com/calkit/calkit
 Project-URL: Issues, https://github.com/calkit/calkit/issues
 Author-email: Pete Bachant <petebachant@gmail.com>
-License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
@@ -75,7 +74,18 @@ forcing them to work at that lower level of abstraction.
 
 ## Installation
 
-Simply run
+To install Calkit, [Git](https://git-scm.com) and Python must be installed.
+If you want to use [Docker](https://docker.com) containers,
+which is typically a good idea,
+that should also be installed.
+For Python, we recommend
+[Mambaforge](https://conda-forge.org/miniforge/).
+If you're a Windows user and decide to install Mambaforge or any other
+Conda-based distribution,
+e.g., Anaconda, you'll probably want to ensure that environment is
+[activated by default in Git Bash](https://discuss.codecademy.com/t/setting-up-conda-in-git-bash/534473).
+
+After Python is installed, run
 
 ```sh
 pip install calkit-python

{calkit_python-0.3.1 → calkit_python-0.3.3}/README.md

@@ -43,7 +43,18 @@ forcing them to work at that lower level of abstraction.
 
 ## Installation
 
-Simply run
+To install Calkit, [Git](https://git-scm.com) and Python must be installed.
+If you want to use [Docker](https://docker.com) containers,
+which is typically a good idea,
+that should also be installed.
+For Python, we recommend
+[Mambaforge](https://conda-forge.org/miniforge/).
+If you're a Windows user and decide to install Mambaforge or any other
+Conda-based distribution,
+e.g., Anaconda, you'll probably want to ensure that environment is
+[activated by default in Git Bash](https://discuss.codecademy.com/t/setting-up-conda-in-git-bash/534473).
+
+After Python is installed, run
 
 ```sh
 pip install calkit-python

{calkit_python-0.3.1 → calkit_python-0.3.3}/calkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.1"
+__version__ = "0.3.3"
 
 from .core import *
 from . import git

{calkit_python-0.3.1 → calkit_python-0.3.3}/calkit/cli/main.py

@@ -298,8 +298,10 @@ def push():
     subprocess.call(["dvc", "push"])
 
 
-@app.command(name="server", help="Run the local server.")
-def run_server():
+@app.command(
+    name="local-server", help="Run the local server to interact over HTTP."
+)
+def run_local_server():
     import uvicorn
 
     uvicorn.run(

{calkit_python-0.3.1 → calkit_python-0.3.3}/calkit/cli/office.py

@@ -15,12 +15,14 @@ office_app = typer.Typer(no_args_is_help=True)
 
 
 @office_app.command(
-    name="excel-chart-to-png",
-    help="Extract a chart from Excel and save to PNG.",
+    name="excel-chart-to-image",
+    help="Extract a chart from Excel and save to image.",
 )
-def excel_chart_to_png(
+def excel_chart_to_image(
     input_fpath: Annotated[str, typer.Argument(help="Input Excel file path.")],
-    output_fpath: Annotated[str, typer.Argument(help="Output PNG file path.")],
+    output_fpath: Annotated[
+        str, typer.Argument(help="Output image file path.")
+    ],
     sheet: Annotated[
         int, typer.Option("--sheet", help="Sheet in workbook.")
     ] = 1,
@@ -34,7 +36,7 @@ def excel_chart_to_png(
         f"Exporting chart at index {chart_index} from sheet {sheet} "
         f"in {input_fpath} to {output_fpath}"
     )
-    calkit.office.excel_chart_to_png(
+    calkit.office.excel_chart_to_image(
         input_fpath=input_fpath,
         output_fpath=output_fpath,
         sheet=sheet,

{calkit_python-0.3.1 → calkit_python-0.3.3}/calkit/office.py

@@ -5,13 +5,13 @@ import os
 from PIL import ImageGrab
 
 
-def excel_chart_to_png(
+def excel_chart_to_image(
     input_fpath: str,
     output_fpath: str,
     sheet: int = 1,
     chart_index: int = 0,
 ):
-    """Export a chart from an Excel sheet to PNG."""
+    """Export a chart from an Excel sheet to image."""
     import win32com.client
 
     # Open the excel application using win32com
@@ -21,22 +21,23 @@ def excel_chart_to_png(
     excel.DisplayAlerts = 0
     # Open workbook
     wb = excel.Workbooks.Open(os.path.abspath(input_fpath))
-    factor = 1.0
     # Extract sheet
     # TODO: Close workbook if something fails
     sheet = excel.Sheets(sheet)
     shape = sheet.Shapes[chart_index]
     shape.Copy()
     image = ImageGrab.grabclipboard()
-    length_x, width_y = image.size
-    size = int(factor * length_x), int(factor * width_y)
-    image_resize = image.resize(size)
-    # Save the image into the existing png file, overwriting if exists
+    # Check if we need to change the mode of the image
+    _, ext = os.path.splitext(output_fpath)
+    if (
+        ext in [".jpg", ".eps", ".tiff", ".gif", ".bmp"]
+        and image.mode != "RGB"
+    ):
+        image = image.convert("RGB")
+    # Save the image, overwriting if exists
     dirname = os.path.dirname(output_fpath)
     if dirname and not os.path.isdir(dirname):
         os.makedirs(dirname)
-    image_resize.save(
-        os.path.abspath(output_fpath), "png", quality=95, dpi=(300, 300)
-    )
+    image.save(os.path.abspath(output_fpath), quality=95, dpi=(300, 300))
     wb.Close(True)
     excel.Quit()

calkit_python-0.3.1/examples/cfd-study/README.md

@@ -1,3 +0,0 @@
-# Calkit CFD study example
-
-This example is not yet complete!

calkit_python-0.3.1/examples/cfd-study/calkit.yaml

@@ -1,9 +0,0 @@
-questions:
-  - What is the drag coefficient of this shape?
-environments:
-  - path: sim/Dockerfile
-    name: cfd
-    kind: docker
-  - path: environment.yml
-    name: processing
-    kind: conda

calkit_python-0.3.1/examples/cfd-study/config/simulations/runs.csv

@@ -1,2 +0,0 @@
-environment,wind_speed,wind_direction
-cfd,1.0,270.0

calkit_python-0.3.1/examples/cfd-study/notebook.ipynb

@@ -1,37 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import calkit\n",
-    "\n",
-    "# Print out the plan of this study\n",
-    "plan = calkit.get_plan()\n",
-    "\n",
-    "# Describe this project\n",
-    "project = calkit.get_project()\n",
-    "\n",
-    "# What are the questions?\n",
-    "print(project.questions)\n",
-    "\n",
-    "# Get the status of the project, i.e., how many more simulations are there\n",
-    "# left to run\n",
-    "# is everything post-processed?\n",
-    "status = calkit.get_status()\n",
-    "\n",
-    "# By default this will run any non-finished simulations locally\n",
-    "calkit.run()"
-   ]
-  }
- ],
- "metadata": {
-  "language_info": {
-   "name": "python"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

calkit_python-0.3.1/examples/ms-office/.gitignore

@@ -1,6 +0,0 @@
-# Keep MS office files out of Git, but still version them
-# maybe they are synced via Dropbox or something, but we still track if
-# they've changed?
-*.docx
-*.xls
-*.xlsx

calkit_python-0.3.1/examples/ms-office/README.md

@@ -1,11 +0,0 @@
-# MS Office user
-
-This example reflects the "non-hacker" researcher who uses Microsoft
-Office (or similar) for a lot of their work.
-Note that there is nothing wrong with this workflow,
-but it is inherently harder for collaboration and reproducibility,
-since version control for MS Office files is tougher.
-
-Our goal with this example is to allow someone who likes Word and Excel
-to keep using those tools, but to still help with organization
-and reproducibility.

calkit_python-0.3.1/examples/ms-office/calkit.yaml

@@ -1,2 +0,0 @@
-questions:
-  - Is it possible to use an office suite in a reproducible way?