Skip to content

Commit

Permalink
Bump to v0.9.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Leedehai committed Dec 16, 2024
1 parent ef5e84f commit 0f0c297
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 15 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:green_book: The [manual](https://github.com/Leedehai/typst-physics/blob/v0.9.3/physica-manual.pdf).
:green_book: The [manual](https://github.com/Leedehai/typst-physics/blob/v0.9.4/physica-manual.pdf).
<p align="center">
<img width="545" alt="logo" src="https://github.com/Leedehai/typst-physics/assets/18319900/ed86198a-8ddb-4473-aed3-8111d5ecde60">
</p>

# The physica package for Typst (v0.9.3)
# The physica package for Typst (v0.9.4)

[![CI](https://github.com/Leedehai/typst-physics/actions/workflows/ci.yml/badge.svg)](https://github.com/Leedehai/typst-physics/actions/workflows/ci.yml)
[![Latest release](https://img.shields.io/github/v/release/Leedehai/typst-physics.svg?color=gold)][latest-release]

Available in the collection of [Typst packages](https://typst.app/docs/packages/): `#import "@preview/physica:0.9.3": *`
Available in the collection of [Typst packages](https://typst.app/docs/packages/): `#import "@preview/physica:0.9.4": *`

> physica _noun_.
> * Latin, study of nature
Expand All @@ -27,7 +27,7 @@ natural sciences, including:

## A quick look

See the [manual](https://github.com/Leedehai/typst-physics/blob/v0.9.3/physica-manual.pdf) for more details and examples.
See the [manual](https://github.com/Leedehai/typst-physics/blob/v0.9.4/physica-manual.pdf) for more details and examples.

![demo-quick](https://github.com/Leedehai/typst-physics/assets/18319900/4a9f40df-f753-4324-8114-c682d270e9c7)

Expand All @@ -50,21 +50,21 @@ compiler locally, it downloads packages on-demand and caches them on-disk, see

```typst
// Style 1
#import "@preview/physica:0.9.3": *
#import "@preview/physica:0.9.4": *
$ curl (grad f), tensor(T, -mu, +nu), pdv(f,x,y,[1,2]) $
```

```typst
// Style 2
#import "@preview/physica:0.9.3": curl, grad, tensor, pdv
#import "@preview/physica:0.9.4": curl, grad, tensor, pdv
$ curl (grad f), tensor(T, -mu, +nu), pdv(f,x,y,[1,2]) $
```

```typst
// Style 3
#import "@preview/physica:0.9.3"
#import "@preview/physica:0.9.4"
$ physica.curl (physica.grad f), physica.tensor(T, -mu, +nu), physica.pdv(f,x,y,[1,2]) $
```
Expand All @@ -84,12 +84,12 @@ Developed with compiler version:

```sh
$ typst --version
typst 0.10.0 (70ca0d25)
typst 0.12.0 (737895d7)
```

## Manual

See the [manual](https://github.com/Leedehai/typst-physics/blob/v0.9.3/physica-manual.pdf) for a more comprehensive coverage, a PDF file
See the [manual](https://github.com/Leedehai/typst-physics/blob/v0.9.4/physica-manual.pdf) for a more comprehensive coverage, a PDF file
generated directly with the [Typst](https://typst.app) binary.

To regenerate the manual, use command
Expand All @@ -107,13 +107,13 @@ request. If it is large, the best first step is creating an issue and let us
explore the design together. Some features might warrant a package on its own.

* Testing: currently testing is done by closely inspecting the generated
[manual](https://github.com/Leedehai/typst-physics/blob/v0.9.3/physica-manual.pdf).
[manual](https://github.com/Leedehai/typst-physics/blob/v0.9.4/physica-manual.pdf).
This does not scale well. I plan to add programmatic testing by comparing
rendered pictures with golden images.

## Change log

[changelog.md](https://github.com/Leedehai/typst-physics/blob/v0.9.3/changelog.md).
[changelog.md](https://github.com/Leedehai/typst-physics/blob/v0.9.4/changelog.md).

## License

Expand Down
7 changes: 7 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## 0.9.4

* Add binary logarithm `lb`.
* Make the differential symbol of `pdv` (partial derivative) customizable.
* Let `tensor` show everything as a superscript if no `+` or `-` is given.
* Documentation improvements; internal refactorings and cleanups.

## 0.9.3

* Add `delim` to `vecrow(..)` to specify the delimiter.
Expand Down
Binary file modified physica-manual.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions physica-manual.typ
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// This document is shared under the Creative Commons BY-ND 4.0 license.
#import "physica.typ": *

#let version = "0.9.3"
#let version = "0.9.4"

#set document(
title: [physica-manual.typ],
Expand Down Expand Up @@ -61,7 +61,7 @@ This manual itself was generated using the Typst CLI and the `physica` package,
With `typst`'s #linkurl("package management", "https://github.com/typst/packages"):

```typst
#import "@preview/physica:0.9.3": *
#import "@preview/physica:0.9.4": *
$ curl (grad f), pdv(,x,y,z,[2,k]), tensor(Gamma,+k,-i,-j) = pdv(vb(e_i),x^j)vb(e^k) $
```
Expand Down
4 changes: 2 additions & 2 deletions typst.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "physica"
version = "0.9.3"
version = "0.9.4"
description = "Math constructs for science and engineering: derivative, differential, vector field, matrix, tensor, Dirac braket, hbar, transpose, conjugate, many operators, and more."
authors = ["Leedehai"]
repository = "https://github.com/Leedehai/typst-physics"
Expand All @@ -18,7 +18,7 @@ keywords = [
"isotope", "signal", "electromagnetism", "mechanics", "quantum", "relativity",
"imaginary", "notation",
]
compiler = "0.10.0"
compiler = "0.12.0"
exclude = ["*.pdf", "*.py"]
entrypoint = "physica.typ"
license = "MIT"

0 comments on commit 0f0c297

Please sign in to comment.