Merge branch 'main' of https://github.com/G1OJS/NECBOL

G1OJS · G1OJS · commit f4817262214c · 2025-07-26T18:26:46.000+01:00
diff --git a/CHANGE history.md b/CHANGE history.md
@@ -1,3 +1,6 @@
+---
+permalink: change-history
+---
 # V3.0.0
 
 Version 3 makes some changes to various functions to enable:
diff --git a/README.md b/README.md
@@ -17,8 +17,8 @@
 - **More coming soon**: See [next steps/future plans](https://github.com/G1OJS/NECBOL/blob/main/TO_DO.md)
 - **Extensible design**: It's written in Python, so you can use the core and add your own code
 - **Example files**: Simple dipole, Hentenna with reflector with example parameter sweep, Circular version of Skeleton Slot Cube with Optimiser code
-
-![Capture](https://github.com/user-attachments/assets/f8d57095-cbbd-4a02-9e40-2d81520a3799)
+  
+![Capture](https://github.com/user-attachments/assets/d9144a6c-4d3f-4bd6-9a4b-52559dc10600)
 
 ## 🛠 Installation
 
@@ -30,14 +30,14 @@ pip install necbol
 ## User Guide
 Documentation is work in progress. In the meantime:
 
-* For a quick and basic overview, see the file "example_dipole_with_detailed_comments.py" for a minimal explanation of how to use this framework.
+* For a quick and basic overview, see the file **"example_dipole_with_detailed_comments.py"** in the examples folder for a minimal explanation of how to use this framework.
 
 * There are several more example files in the [examples folder](https://github.com/G1OJS/NECBOL/tree/main/examples) intended to highlight different aspects of necbol and different ways of doing similar things. You can copy these examples and modify to see how they work, or start your own from scratch.
 
 * Automated user documentation is [here](https://g1ojs.github.io/NECBOL/docs/user_functions.html). You can see an outline of all code [here](https://g1ojs.github.io/NECBOL/docs/outline.html).
   
 * You can browse the source files in the [necbol folder](https://github.com/G1OJS/NECBOL/tree/main/necbol) (however note that they may be ahead of the release on pip).
 
-* Please look at the change history file, especally if you've used previous versions
+* Please look at the [change history](https://g1ojs.github.io/NECBOL/change-history), especally if you've used previous versions
   
 * Note that the TO_DO list has been deleted and captured in GitHub issues
diff --git a/docs/outline.html b/docs/outline.html
@@ -1,7 +1,28 @@
 <!DOCTYPE html><html lang='en'>
 <head>
 <title>outline.html</title><link rel='stylesheet' href='./outline.css' /><body>
-<br><div class = 'filename'>__init__.py</div><br><br><div class = 'filename'>analyser.py</div><br><details><summary><span class ='body signature'> body</span></summary>
+<br><div class = 'filename'>__init__.py</div><br><details><summary><span class ='docstring signature'> docstring</span></summary>
+<pre class ='docstring content'>    Standard Python initialiser handling imports from modules and version number
+</pre>
+</details>
+<details><summary><span class ='body signature'> body</span></summary>
+<pre class ='body content'>from necbol.components import *
+from necbol.visualiser import *
+from necbol.analyser import *
+from necbol.modeller import *
+from necbol.optimisers import *
+
+from importlib.metadata import version
+try:
+    __version__ = version(&quot;necbol&quot;)
+except:
+    __version__ = &quot;&quot;
+print(f&quot;\nNECBOL V{__version__} by Dr Alan Robinson G1OJS\n\n&quot;)
+
+
+</pre>
+</details>
+<br><div class = 'filename'>analyser.py</div><br><details><summary><span class ='body signature'> body</span></summary>
 <pre class ='body content'>
 </pre>
 </details>
