From 2c2b88a6c612e2043aab040ba4bdf16f1a28cbe0 Mon Sep 17 00:00:00 2001 From: Ian Jauslin Date: Wed, 10 May 2023 15:03:28 -0400 Subject: [PATCH 1/4] Add README --- README | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..b371f50 --- /dev/null +++ b/README @@ -0,0 +1,61 @@ +Jam is visualization software for hard-core lattice particle systems. It is +designed to explore configurations of particles while enforcing that no two +particles overlap. + +**Jam is a work in progress and is nowhere near ready for production.** + + +# Basic usage + +Run with +```bash + ./src/jam [configuration_file] +``` +where `[configuration_file]` is an optional argument that specifies a file with +a list of particle positions that will be loaded on initial execution. + + +# User interface + + * ``: create a new particle under the mouse pointer (if the + particle fits) + + * ``: select/unselect multiple particles + + * `` and drag: move selected particle(s). + + * `backspace`: delete selected particle(s) + + +# Commands + +Commands can be executed by typing `:` (similarly to vim). + + * `:q`: exit + + * `:w [path_to_file]`: Write particle configuration to file. This will not + overwrite existing files; use `:w!` to overwrite. + + * `:e `: edit file. + + * `:export `: Export configuration to LaTeX (using TikZ) + + * `:set color `: Set color of selected particles to + ``. The supported format for `` is either `r,g,b` + with `r`, `g`, and `b` in [0,1], or one of + `red|green|blue|brown|lime|orange|pink|purple|teal|violet|cyan|magenta|yellow|olive|black|darkgray|gray|lightgray|white`. + + * `:set zoom `: Scale all particles by ``. + + * `:set grid [on|off]`: Add a visual grid centered on one of the selected + particles. The size of the mesh can be specified by passing + `:set grid `. + + +# Current developments + +So far, Jam only supports cross-shaped particles, but work is in progress to +support arbitrary shapes consisting of rectangles, circle arcs and triangles +(check out the `dev` branch to follow the progress). + +Support for lattice configurations is also ongoing. From dc4aef21199faec0a095aaee456395ef38d79a72 Mon Sep 17 00:00:00 2001 From: Ian Jauslin Date: Wed, 10 May 2023 15:08:58 -0400 Subject: [PATCH 2/4] Add License --- LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++ README | 7 ++ TeX/jam.sty | 14 +++ src/colors.py | 14 +++ src/command_prompt.py | 14 +++ src/filecheck.py | 14 +++ src/jam | 15 ++++ src/jam.kv | 14 +++ src/painter.py | 14 +++ src/point.py | 14 +++ src/polyomino.py | 14 +++ 11 files changed, 336 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README b/README index b371f50..05a082f 100644 --- a/README +++ b/README @@ -59,3 +59,10 @@ support arbitrary shapes consisting of rectangles, circle arcs and triangles (check out the `dev` branch to follow the progress). Support for lattice configurations is also ongoing. + + +# License + +Jam is distributed under the Apache 2.0 License. + +Copyright 2021-2023 Ian Jauslin diff --git a/TeX/jam.sty b/TeX/jam.sty index bf07ec4..9dd1ac3 100644 --- a/TeX/jam.sty +++ b/TeX/jam.sty @@ -1,3 +1,17 @@ +% Copyright 2021-2023 Ian Jauslin +% +% Licensed under the Apache License, Version 2.0 (the "License"); +% you may not use this file except in compliance with the License. +% You may obtain a copy of the License at +% +% http://www.apache.org/licenses/LICENSE-2.0 +% +% Unless required by applicable law or agreed to in writing, software +% distributed under the License is distributed on an "AS IS" BASIS, +% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +% See the License for the specific language governing permissions and +% limitations under the License. + % square lattice (width #1, height #2, origin #3, spacing #4) \def\grid#1#2#3{ \foreach\i in {0,...,#2}{ diff --git a/src/colors.py b/src/colors.py index 39d77a1..1680b88 100644 --- a/src/colors.py +++ b/src/colors.py @@ -1,3 +1,17 @@ +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # find named color that is closest to rgb values def closest_color(rgb,names): name="" diff --git a/src/command_prompt.py b/src/command_prompt.py index fece1aa..7bbe4b1 100644 --- a/src/command_prompt.py +++ b/src/command_prompt.py @@ -1,3 +1,17 @@ +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + from kivy.uix.label import Label from kivy.core.window import Window from kivy.graphics import Color,Rectangle diff --git a/src/filecheck.py b/src/filecheck.py index 36631b1..a3e2a4c 100644 --- a/src/filecheck.py +++ b/src/filecheck.py @@ -1,3 +1,17 @@ +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + import os.path # check that a file can be edited diff --git a/src/jam b/src/jam index da0a3ad..24698c0 100755 --- a/src/jam +++ b/src/jam @@ -1,5 +1,20 @@ #!/usr/bin/env python3 +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + from kivy.app import App from kivy.uix.widget import Widget from kivy.uix.boxlayout import BoxLayout diff --git a/src/jam.kv b/src/jam.kv index 6491feb..094947f 100644 --- a/src/jam.kv +++ b/src/jam.kv @@ -1,5 +1,19 @@ #: kivy 2.0.0 +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + : canvas.before: Color: diff --git a/src/painter.py b/src/painter.py index bd32c0a..473e35c 100644 --- a/src/painter.py +++ b/src/painter.py @@ -1,3 +1,17 @@ +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + import sys import math from kivy.uix.widget import Widget diff --git a/src/point.py b/src/point.py index eaf8dd6..9d1d7f3 100644 --- a/src/point.py +++ b/src/point.py @@ -1,3 +1,17 @@ +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + import math # point in two dimensions diff --git a/src/polyomino.py b/src/polyomino.py index 8a96de8..7d86a39 100644 --- a/src/polyomino.py +++ b/src/polyomino.py @@ -1,3 +1,17 @@ +# Copyright 2021-2023 Ian Jauslin +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + import math import sys from kivy.graphics import Color,Line,Rectangle From 5e425be0989db3de4f8b7685c35af34a307df82e Mon Sep 17 00:00:00 2001 From: Ian Jauslin Date: Wed, 10 May 2023 15:11:27 -0400 Subject: [PATCH 3/4] markdown in README --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 3b3053fc3a19826a530b8e2bf208d5d431c54e26 Mon Sep 17 00:00:00 2001 From: Ian Jauslin Date: Wed, 10 May 2023 15:20:48 -0400 Subject: [PATCH 4/4] Dependencies in README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 05a082f..17b594b 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,11 @@ where `[configuration_file]` is an optional argument that specifies a file with a list of particle positions that will be loaded on initial execution. +# Dependencies + +Jam is written in Python 3, and uses Kivy to run the GUI. + + # User interface * ``: create a new particle under the mouse pointer (if the