Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
phiarchitect committed Nov 3, 2023
0 parents commit e94a758
Show file tree
Hide file tree
Showing 52 changed files with 1,035 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .ctags
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
--exclude=.git
--exclude=.archive
--exclude=docs
--exclude=.ipynb_checkpoints
--exclude=__pycache__
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: [geometor]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
20 changes: 20 additions & 0 deletions .github/workflows/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Build and Deploy Sphinx

on:
push:
branches:
- main # or master, depending on your default branch name

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: actions/checkout@v3
uses: actions/checkout@v3

- name: photon-platform/action-deploy-sphinx-gh-pages
uses: photon-platform/action-deploy-sphinx-gh-pages@v12
with:
modules_repo_urls: 'https://github.com/geometor/model.git,https://github.com/geometor/render.git,https://github.com/geometor/divine.git'
# python_version: '3.x' # Optional, default is '3.x'
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
*.egg-info
*.egg-info/
dist/
*.py[cod]
*.swp
.doctrees
.ipynb_checkpoints
__pycache__
tags
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) geometor

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.
45 changes: 45 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
explorer
========


Features
--------

.. todo:: TODO: insert features

Installation
------------

You can install **explorer** using pip:

.. code-block:: bash
pip install geometor-explorer
Usage
-----

After installation, you can use the ``explorer`` command to create a new project:

.. code-block:: bash
explorer
.. todo:: TODO: list arguments

Dependencies
------------

**explorer** depends on the following Python packages:

.. todo:: TODO: read from pyproject.toml

Contributing
------------

Contributions are welcome! Please see our [GitHub issues](https://github.com/geometor/explorer/issues) for ways to contribute.

License
-------

**explorer** is licensed under the MIT License. See the `LICENSE` file for more details.
1 change: 1 addition & 0 deletions docsrc/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* @import url('https://fonts.googleapis.com/css2?family=Fira+Sans+Condensed:ital,wght@0,400;0,700;1,400;1,700&display=swap'); */
114 changes: 114 additions & 0 deletions docsrc/_static/css/rtd-dark.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/*!
* @name Readthedocs
* @namespace http://userstyles.org
* @description Styles the documentation pages hosted on Readthedocs.io
* @author Anthony Post
* @homepage https://userstyles.org/styles/142968
* @version 0.20170529055029
*
* Modified by Aloïs Dreyfus: 20200527-1037
* Modified by Erik Kalkoken: 20220615
*/

@media (prefers-color-scheme: dark) {
a:visited {
color: #bf84d8;
}

pre {
background-color: #2d2d2d !important;
}

.wy-nav-content {
background: #3c3c3c;
color: aliceblue;
}

.method dt, .class dt, .data dt, .attribute dt, .function dt,
.descclassname, .descname {
background-color: #525252 !important;
color: white !important;
}

.toc-backref {
color: grey !important;
}

code.literal {
background-color: #2d2d2d !important;
border: 1px solid #6d6d6d !important;
}

.wy-nav-content-wrap {
background-color: rgba(0, 0, 0, 0.6) !important;
}

.sidebar {
background-color: #191919 !important;
}

.sidebar-title {
background-color: #2b2b2b !important;
}

.xref, .py-meth {
color: #7ec3e6 !important;
}

.admonition, .note {
background-color: #2d2d2d !important;
}

.wy-side-nav-search {
background-color: inherit;
border-bottom: 1px solid #fcfcfc;
}

.wy-table thead, .rst-content table.docutils thead, .rst-content table.field-list thead {
background-color: #b9b9b9;
}

.wy-table thead th, .rst-content table.docutils thead th, .rst-content table.field-list thead th {
border: solid 2px #e1e4e5;
}

.wy-table thead p, .rst-content table.docutils thead p, .rst-content table.field-list thead p {
margin: 0;
}

.wy-table-odd td, .wy-table-striped tr:nth-child(2n-1) td, .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td {
background-color: #343131;
}

.highlight .m {
color: inherit
}

/* Literal.Number */
.highlight .nv {
color: #3a7ca8
}

/* Name.Variable */

body {
text-align: justify;
}

.rst-content .section .admonition ul {
margin-bottom: 0;
}

li.toctree-l1 {
margin-top: 5px;
margin-bottom: 5px;
}

.wy-menu-vertical li code {
color: #E74C3C;
}

.wy-menu-vertical .xref {
color: #2980B9 !important;
}
}
Binary file added docsrc/_static/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docsrc/_static/splash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docsrc/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
from ablog.conf import *

org = 'geometor'
org_name = 'GEOMETOR'

repo = 'explorer'
repo_name = 'explorer'

blog_title = f'{org_name}{repo_name}'
project = f'{org_name}<br/>•<br/>{repo_name}'
version = '' # The short X.Y version.
release = '' # The full version, including alpha/beta/rc tags.

copyright = f'{year}, {org_name}'
author = f'{org_name}'

# Base URL for the website, required for generating feeds.
# e.g. blog_baseurl = "http://example.com/"
blog_baseurl = f'https://{org}.github.io/{repo}'
html_base_url = blog_baseurl
html_baseurl = blog_baseurl

blog_authors = {
"phi": ("phi ARCHITECT", None),
}

extensions.append('sphinx_rtd_theme')

html_theme = 'sphinx_rtd_theme'

html_css_files = [ "css/rtd-dark.css" ]

html_theme_options = {
# 'logo': 'logo.png',
# 'logo_name': True,
# 'github_user': org,
# 'github_repo': repo,
# 'github_button': True,
'navigation_depth': -1,
'prev_next_buttons_location': 'both',
}

32 changes: 32 additions & 0 deletions docsrc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
GEOMETOR • explorer
===================

.. include:: ../README.rst

recent logs:
------------

.. postlist:: 5
:excerpts:


contents:
---------

.. toctree::
:hidden:
:maxdepth: 2

usage.rst
modules/index.rst
refs/index.rst
log </log#https://>



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
8 changes: 8 additions & 0 deletions docsrc/log/22.348-045718.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Welcome to the GEOMETOR explorer project
========================================

.. post:: 22.348-045718
:tags:
:category: STATUS

search for patterns in logic and nature
38 changes: 38 additions & 0 deletions docsrc/log/23.109-110629/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Next steps for Geometor Explorer
================================

.. post:: 23.109-110629
:tags:
:category:

separate the UI from the logic of model, render, analyze


- Discussed and finalized the package structure for the Geometor projects:
- geometor.model
- geometor.render
- geometor.explorer

- Designed the UI for the Geometor Explorer application using PyQt6.

- Discussed the requirements for using PyQt6 and decided to use PyQt6 for the project.

TODO
----

.. todo:: Implement the model building functionality in the Geometor Explorer application.

.. todo:: Integrate the geometor.model, geometor.render, and other required libraries into the Geometor Explorer application.

.. todo:: Add error handling and validation mechanisms in the Geometor Explorer application.

.. todo:: Implement file loading and saving functionality in the Geometor Explorer application.

.. todo:: Customize the appearance of the Geometor Explorer interface, such as applying custom styles, themes, or icons.

.. todo:: Add support for multiple rendering methods in geometor.render (e.g., Vispy, SVG).

.. todo:: Develop and integrate analysis functionality, possibly moving the current 'analyze' subpackage to the 'divine' subproject.

.. todo:: Update the documentation for geometor.model and geometor.render using Intersphinx to cross-reference between the packages.

19 changes: 19 additions & 0 deletions docsrc/log/23.110-131951/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Setting up a UI for Explorer
============================

.. post:: 23.110-131951
:tags:
:category:


- Tried to use PyQt6 as the GUI toolkit but faced issues with platform plugins
- Switched to using Tkinter for GUI development
- Implemented a modular design with separate classes for the header, footer, and main window
- Added a `Construction` class to the `geometor.core` package for creating and managing geometric constructions
- Added `Element`, `Point`, `Line`, and `Circle` classes to the `geometor.core` package for representing geometric elements
- Added a `MainWindow` class to the `geometor.explorer.ui` package for displaying the construction and interacting with the user
- Added a `MainPanel` class to the `geometor.explorer.ui` package for managing the three panels of the main window: the element list, the matplotlib view, and the view controls
- Added a `Footer` class to the `geometor.explorer.ui` package for displaying the details of selected elements and the actions for editing the model
- Added a `Header` class to the `geometor.explorer.ui` package for displaying key information about the model and buttons for model actions
- Demonstrated the use of docstrings and type annotations for improving code readability and maintainability

15 changes: 15 additions & 0 deletions docsrc/modules/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
geometor.explorer
=================

.. automodule:: geometor.explorer
:members:
:undoc-members:
:show-inheritance:


.. toctree::
:maxdepth: 2




Loading

0 comments on commit e94a758

Please sign in to comment.