VeraGridServer 5.4.0__tar.gz

veragridserver-5.4.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.1
+Name: VeraGridServer
+Version: 5.4.0
+Summary: VeraGrid is a Power Systems simulation program intended for professional use and research
+Home-page: https://github.com/SanPen/VeraGrid
+Author: Santiago Peñate Vera et. Al.
+Author-email: spenate@eroots.tech
+License: MPL2
+Keywords: power systems planning
+Classifier:  Programming Language :: Python :: 3.10
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: gch5
+
+# VeraGrid 
+This software aims to be a complete platform for power systems research and simulation.)
+
+[Watch the video https](https://youtu.be/SY66WgLGo54)
+[Check out the documentation](https://veragrid.readthedocs.io)
+
+## Installation
+
+pip install veragrid
+
+For more options (including a standalone setup one), follow the
+[installation instructions]( https://veragrid.readthedocs.io/en/latest/getting_started/install.html)
+from the project's [documentation](https://veragrid.readthedocs.io)
+

veragridserver-5.4.0/VeraGridServer/LICENSE.txt

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in 
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

veragridserver-5.4.0/VeraGridServer/__init__.py

@@ -0,0 +1,4 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0

veragridserver-5.4.0/VeraGridServer/__version__.py

@@ -0,0 +1,26 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.  
+# SPDX-License-Identifier: MPL-2.0
+import datetime
+_current_year_ = datetime.datetime.now().year
+
+# remember to keep a three-number version!!!
+__VeraGridServer_VERSION__ = "5.4.0"
+
+url = 'https://github.com/SanPen/VeraGrid'
+
+about_msg = "VeraGridServer v" + str(__VeraGridServer_VERSION__) + '\n\n'
+
+about_msg += """
+VeraGrid has been carefully crafted since 2015 to 
+serve as a platform for research and consultancy.\n"""
+
+about_msg += """
+This program is free software; you can redistribute it and/or
+modify it subject to the terms of the Mozilla Public License, v. 2.0. 
+If a copy of the MPL was not distributed with this file, 
+You can obtain one at https://mozilla.org/MPL/2.0/.
+
+The source of VeraGrid can be found at:
+""" + url + "\n\n"

veragridserver-5.4.0/VeraGridServer/connection_example.py

@@ -0,0 +1,56 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+import os
+import asyncio
+import websockets
+from typing import Callable
+
+
+async def send_large_file(file_path: str,
+                          websocket: websockets.WebSocketClientProtocol,
+                          progress_func: Callable[[float], None] = None) -> None:
+    """
+    Send a large file via web-socket
+    :param file_path: local file path
+    :param websocket: web socket instance
+    :param progress_func: Progress function
+    :return: None
+    """
+    # Get the size of the file
+    file_size = os.path.getsize(file_path)
+    bytes_sent = 0
+
+    # Open the file in binary mode
+    with open(file_path, "rb") as file:
+        # Read the file in chunks
+        while True:
+            # Read 4KB of data
+            data = file.read(4096)
+            if not data:
+                break  # End of file
+
+            # Send the chunk over the WebSocket
+            await websocket.send(data)
+
+            # Update bytes sent
+            bytes_sent += len(data)
+
+            # Calculate progress
+            progress = (bytes_sent / file_size) * 100
+
+            if progress_func is not None:
+                progress_func(progress)
+
+
+async def connect_and_send(file_path: str, url: str = 'ws://localhost:8000/ws'):
+    """
+    Connect and send data to web-socket
+    """
+    async with websockets.connect(url) as websocket:
+        await send_large_file(file_path, websocket)
+
+
+if __name__ == '__main__':
+    asyncio.get_event_loop().run_until_complete(connect_and_send(file_path="my_file.dat", url="ws://localhost:8000"))

veragridserver-5.4.0/VeraGridServer/endpoints/calculations.py

@@ -0,0 +1,9 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+
+from fastapi import APIRouter
+
+router = APIRouter()
+

veragridserver-5.4.0/VeraGridServer/endpoints/jobs.py

@@ -0,0 +1,221 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+import os
+import json
+from typing import Dict
+from fastapi import APIRouter, HTTPException, BackgroundTasks, Response
+from starlette.responses import StreamingResponse
+
+from VeraGridEngine.IO.veragrid.remote import RemoteInstruction, RemoteJob, run_job
+from VeraGridEngine.IO.veragrid.pack_unpack import parse_veragrid_data
+from VeraGridEngine.Devices.multi_circuit import MultiCircuit
+from VeraGridEngine.enumerations import SimulationTypes, JobStatus
+
+router = APIRouter()
+
+JOBS_LIST: Dict[str, RemoteJob] = dict()
+
+
+def get_fs_folder() -> str:
+    """
+    Get the folder where to save files
+    :return:
+    """
+    return "."
+
+
+def generate_job_file_path(job_id: str):
+    """
+
+    :param job_id:
+    :return:
+    """
+    return os.path.join(get_fs_folder(), f"{job_id}.zip")
+
+
+async def process_json_data(json_data: Dict[str, Dict[str, Dict[str, str]]]):
+    """
+    Action called on the upload
+    :param json_data: the grid info generated with 'gather_model_as_jsons_for_communication'
+    """
+    grid = parse_veragrid_data(data=json_data)
+    print(f'Circuit loaded alright nbus{grid.get_bus_number()}, '
+          f'nbr{grid.get_branch_number(add_vsc=False, add_hvdc=False, add_switch=True)}')
+
+    if 'instruction' in json_data:
+        instruction = RemoteInstruction(data=json_data['instruction'])
+
+        job = RemoteJob(grid=grid, instruction=instruction)
+
+        # register the job
+        JOBS_LIST[job.id_tag] = job
+
+        # print("Job data\n", job.get_data())
+        if job.instruction.operation != SimulationTypes.NoSim:
+            driver = run_job(grid=grid, job=job)
+
+            if driver is not None:
+                print("Driver:", driver.name)
+                if driver.results is not None:
+                    return driver.results.get_dict()
+                else:
+                    return dict()
+            else:
+                return dict()
+
+        else:
+            print("No simulation")
+            return dict()
+
+    else:
+        print('No Instruction found\n\n', json_data)
+        return dict()
+
+
+async def stream_load_json(json_data):
+    """
+    Async function to stream a json file
+    :param json_data:
+    :return:
+    """
+
+    async def generate():
+        """
+        generate
+        """
+        yield json.dumps(json_data).encode()
+
+    return StreamingResponse(generate())
+
+
+@router.post("/upload_job/")
+async def upload_job(json_data: dict, background_tasks: BackgroundTasks):
+    """
+    Endpoint to upload a job into here
+    :param json_data:
+    :param background_tasks:
+    :return:
+    """
+    background_tasks.add_task(stream_load_json, json_data)
+
+    grid: MultiCircuit = parse_veragrid_data(data=json_data)
+
+    print(f'Circuit loaded alright nbus{grid.get_bus_number()}, '
+          f'nbr{grid.get_branch_number(add_vsc=False, add_hvdc=False, add_switch=True)}')
+
+    if 'instruction' in json_data:
+        instruction = RemoteInstruction(data=json_data['instruction'])
+
+        job = RemoteJob(grid=grid, instruction=instruction)
+
+        # register the job
+        JOBS_LIST[job.id_tag] = job
+        job.status = JobStatus.Running
+
+        # print("Job data\n", job.get_data())
+        if job.instruction.operation != SimulationTypes.NoSim:
+
+            try:
+                driver = run_job(grid=grid, job=job)
+            except Exception as e:
+                print("Job running error:\n", e)
+                return {"success": False, "results": None, "msg": f"Job running error"}
+
+            job.status = JobStatus.Done
+            JOBS_LIST.pop(job.id_tag)
+
+            if driver is not None:
+                print("Driver:", driver.name)
+                if driver.results is not None:
+                    return {"success": True, "results": driver.results.get_dict(), "msg": "all good"}
+                else:
+                    return {"success": False, "results": None, "msg": "No results in the driver"}
+            else:
+                return {"success": False, "results": None, "msg": "The driver is None"}
+
+        else:
+            return {"success": False, "results": None, "msg": "No simulation"}
+
+    else:
+        return {"success": False, "results": None, "msg": "No Instruction found"}
+
+
+@router.get("/jobs_list")
+async def jobs_list():
+    """
+    Endpoint to return the list of jobs
+    :return: string
+    """
+    return [job.get_data() for id_tag, job in JOBS_LIST.items()]
+
+
+@router.delete("/jobs/{job_id}")
+async def delete_job(job_id: str):
+    """
+    Delete a specific job by ID
+    :param job_id: The ID of the job to delete_with_dialogue
+    :return: A message indicating the result
+    """
+    if job_id in JOBS_LIST:
+        del JOBS_LIST[job_id]
+        return {"message": f"Job {job_id} deleted successfully"}
+    else:
+        raise HTTPException(status_code=404, detail="Job not found")
+
+
+@router.post("/jobs/{job_id}/cancel")
+async def cancel_job(job_id: str):
+    """
+    Cancel a specific job by ID
+    :param job_id: The ID of the job to cancel
+    :return: A message indicating the result
+    """
+    job = JOBS_LIST.get(job_id)
+    if not job:
+        raise HTTPException(status_code=404, detail="Job not found")
+
+    job.cancel()
+    return {"message": f"Job {job_id} canceled successfully"}
+
+
+@router.get("/download_results/{job_id}")
+async def download_large_file(job_id: str):
+    """
+    Function to download a large file, ie the results of a simulation
+    """
+
+    job = JOBS_LIST.get(job_id, None)
+
+    if job is None:
+        return Response(status_code=404, content="Job not found")
+
+    if job.status != JobStatus.Done:
+        return Response(status_code=405, content="Job not finished yet :/")
+
+    # Path to your large binary file
+    file_path = generate_job_file_path(job_id=job_id)
+
+    # Check if the file exists
+    if not os.path.exists(file_path):
+        return Response(status_code=406, content=f"File not found {file_path}")
+
+    # Function to stream the file
+    def iter_file(chunk_size=1024 * 1024):
+        """
+
+        :param chunk_size:
+        :return:
+        """
+        with open(file_path, "rb") as file:
+            sent = 0
+            while chunk := file.read(chunk_size):  # Read in chunks of 1MB
+                sent += chunk_size
+                job.progress = f"{sent} MB"
+                yield chunk
+
+    print("Sending", job_id)
+
+    # Return a streaming response
+    return StreamingResponse(iter_file(), media_type="application/octet-stream")

veragridserver-5.4.0/VeraGridServer/endpoints/register_in_master.py

@@ -0,0 +1,68 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+
+import socket
+import requests
+from fastapi import APIRouter
+
+from VeraGridServer.settings import settings
+
+
+def get_local_ip():
+    try:
+        return socket.gethostbyname(socket.gethostname())  # Gets internal IP
+    except Exception:
+        return "127.0.0.1"  # Fallback to localhost
+
+
+def register_with_master(host: str, port: int, this_port: int, username: str, password: str):
+    """
+    register this service with a master service
+    :param host:
+    :param port:
+    :param this_port:
+    :param username:
+    :param password:
+    :return:
+    """
+
+    url = f"{host}:{port}/register_child_server"
+
+    worker_data = {
+        "ip": get_local_ip(),  # Detect IP dynamically
+        "port": this_port,  # Set worker's port
+        "username": username,
+        "password": password,
+    }
+
+    response = requests.post(url,
+                             json=worker_data,
+                             verify=False,
+                             timeout=5)
+    response.raise_for_status()
+    return response.json()  # Return JSON response
+
+
+def lifespan(app: APIRouter):
+    """
+    Function that is called once the app starts.
+    :param app:
+    :return:
+    """
+    if not settings.am_i_master:
+        print("I am a child service")
+        res = register_with_master(host=settings.master_host,
+                                   port=settings.master_port,
+                                   this_port=settings.this_port,
+                                   username=settings.this_username,
+                                   password=settings.this_password)
+        print("registering response:", res)
+    else:
+        print("I am the master service")
+
+    yield  # The application runs here
+
+
+router = APIRouter(lifespan=lifespan)

veragridserver-5.4.0/VeraGridServer/endpoints/register_sub_servers.py

@@ -0,0 +1,48 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+
+from fastapi import APIRouter, HTTPException
+
+# Dictionary to store registered services
+registered_services = dict()
+
+router = APIRouter()
+
+
+@router.post("/register_child_server")
+async def register_child_server(data: dict):
+    try:
+        # data = await request.json()  # Parse JSON manually
+        ip = data.get("ip", None)
+        port = data.get("port", None)
+        username = data.get("username", None)
+        password = data.get("password", None)
+
+        key = f"{username}:{ip}:{port}"
+
+        if ip is None or port is None:
+            raise HTTPException(status_code=400, detail="Missing 'ip' or 'port'")
+
+        if key in registered_services:
+            raise HTTPException(status_code=400, detail="Service already registered")
+
+        # Store the service information
+        registered_services[key] = {"ip": ip, "port": port}
+
+        return {"message": "Service registered successfully", "service": username, "ip": ip, "port": port}
+
+    except Exception as e:
+        raise HTTPException(status_code=400, detail=f"Invalid request: {str(e)}")
+
+
+@router.get("/registered_child_servers")
+def get_registered_child_servers():
+    """
+    Return all registered services
+    :return:
+    """
+    if not registered_services:
+        raise HTTPException(status_code=404, detail="No services registered")
+    return registered_services

veragridserver-5.4.0/VeraGridServer/generate_ssl_key.py

@@ -0,0 +1,97 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+from cryptography import x509
+from cryptography.x509.oid import NameOID
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import hashes, serialization
+from cryptography.hazmat.primitives.asymmetric import rsa
+import datetime
+import socket
+import ipaddress
+
+
+def get_my_ip():
+    """Returns the IP address of the machine running the FastAPI server."""
+    try:
+        # Connect to an external server (Google's DNS) to determine our outward-facing IP
+        s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        s.connect(("8.8.8.8", 80))
+        ip = s.getsockname()[0]
+        s.close()
+    except Exception:
+        ip = "127.0.0.1"  # Fallback to localhost if detection fails
+    return ip
+
+
+def generate_ssl_certificate(ip: str | None = None, domain: str | None = None,
+                             key_file_name="key.pem", cert_file_name="cert.pem"):
+    """
+    Generates a new SSL certificate and saves it to a file
+    :param ip: IP address of the server (optional)
+    :param domain: Domain name of the server (optional)
+    :param key_file_name: name of the key file
+    :param cert_file_name: name of the certificate file
+    """
+
+    subjects_list = [x509.DNSName(u"localhost")]
+
+    if ip is not None:
+        subjects_list.append(x509.IPAddress(ipaddress.ip_address(ip)))
+
+    if domain is not None:
+        subjects_list.append(x509.DNSName(domain))
+
+    # Generate a private key
+    private_key = rsa.generate_private_key(
+        public_exponent=65537,
+        key_size=2048,
+        backend=default_backend()
+    )
+
+    # Write the private key to a file
+    with open(key_file_name, "wb") as key_file:
+        key_file.write(private_key.private_bytes(
+            encoding=serialization.Encoding.PEM,
+            format=serialization.PrivateFormat.TraditionalOpenSSL,
+            encryption_algorithm=serialization.NoEncryption()
+        ))
+
+    # Define certificate subject and issuer details
+    subject = issuer = x509.Name([
+        x509.NameAttribute(NameOID.COUNTRY_NAME, u"ES"),
+        x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, u"Barcelona"),
+        x509.NameAttribute(NameOID.LOCALITY_NAME, u"Barcelona"),
+        x509.NameAttribute(NameOID.ORGANIZATION_NAME, u"eRoots Analytics"),
+        x509.NameAttribute(NameOID.COMMON_NAME, ip),
+    ])
+
+    # Build the certificate
+    cert = x509.CertificateBuilder().subject_name(
+        subject
+    ).issuer_name(
+        issuer
+    ).public_key(
+        private_key.public_key()
+    ).serial_number(
+        x509.random_serial_number()
+    ).not_valid_before(
+        datetime.datetime.now(datetime.UTC)
+    ).not_valid_after(
+        # Certificate is valid for 365 days
+        datetime.datetime.now(datetime.UTC) + datetime.timedelta(days=365)
+    ).add_extension(
+        x509.SubjectAlternativeName(subjects_list),
+        critical=False,
+    ).sign(private_key, hashes.SHA256(), default_backend())
+
+    # Write the certificate to a file
+    with open(cert_file_name, "wb") as cert_file:
+        cert_file.write(cert.public_bytes(serialization.Encoding.PEM))
+
+    print(f"SSL certificate and key have been generated: cert={cert_file_name}, key={key_file_name}")
+
+
+if __name__ == "__main__":
+    generate_ssl_certificate(ip="127.0.0.1", key_file_name="key.pem")

veragridserver-5.4.0/VeraGridServer/main.py

@@ -0,0 +1,77 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+import os
+from hashlib import sha256
+from fastapi import FastAPI, Header, HTTPException, Response, Query
+from fastapi.responses import FileResponse
+
+from VeraGridServer.endpoints import register_in_master
+from VeraGridServer.endpoints import register_sub_servers
+from VeraGridServer.endpoints import calculations
+from VeraGridServer.endpoints import jobs
+from cryptography import x509
+from cryptography.x509.oid import NameOID
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives.asymmetric import rsa
+from cryptography.hazmat.primitives.serialization import Encoding, PrivateFormat, NoEncryption
+from datetime import datetime, timedelta
+import ipaddress
+
+app = FastAPI()
+app.include_router(register_in_master.router)
+app.include_router(register_sub_servers.router)
+app.include_router(calculations.router)
+app.include_router(jobs.router)
+
+# Store WebSocket connections in a set
+__connections__ = set()
+
+# GC_FOLDER = get_create_gridcal_folder()
+# GC_SERVER_FILE = os.path.join(GC_FOLDER, "server_config.json")
+SECRET_KEY = ""
+
+
+def verify_api_key(api_key: str = Header(None)):
+    """
+    Define a function to verify the API key
+    :param api_key:
+    """
+    if api_key is None:
+        raise HTTPException(status_code=401, detail="API Key is missing")
+
+    # Hash the provided API key using the same algorithm and compare with the stored hash
+    hashed_api_key = sha256(api_key.encode()).hexdigest()
+    if hashed_api_key != SECRET_KEY:
+        raise HTTPException(status_code=403, detail="Invalid API Key")
+
+
+
+@app.get("/get_cert")
+def get_cert():
+    """
+    Get the certificate from the server
+    :return:
+    """
+    # Serve the certificate file
+    return FileResponse("cert.pem",
+                        media_type="application/x-pem-file",
+                        filename="cert.pem")
+
+@app.get("/")
+async def read_root():
+    """
+    Root
+    :return: string
+    """
+    return {"message": "VeraGrid server running", "status": "ok"}
+
+
+@app.get('/favicon.ico', include_in_schema=False)
+async def favicon():
+    """
+
+    :return:
+    """
+    return FileResponse(os.path.join(os.path.dirname(__file__), "data", "VeraGrid_icon.ico"))

veragridserver-5.4.0/VeraGridServer/run.py

@@ -0,0 +1,122 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+import os
+import sys
+import uvicorn
+import argparse
+
+PACKAGE_PARENT = '..'
+SCRIPT_DIR = os.path.dirname(os.path.realpath(os.path.join(os.getcwd(), os.path.expanduser(__file__))))
+sys.path.append(os.path.normpath(os.path.join(SCRIPT_DIR, PACKAGE_PARENT)))
+
+from VeraGridServer.main import app
+from VeraGridServer.settings import settings
+from VeraGridServer.generate_ssl_key import generate_ssl_certificate, get_my_ip
+from VeraGridServer.__version__ import __VeraGridServer_VERSION__
+
+
+def start_server(key_file_name: str = "key.pem", cert_file_name: str = "cert.pem",
+                 port: int = 8000, domain="localhost",
+                 master_host: str = "", master_port: int = 0,
+                 username: str = "", password: str = "", is_master: bool = True,
+                 secure: bool = True):
+    """
+    Start server function
+    :param key_file_name: name of the key file that the server generates
+    :param cert_file_name: name of the certificate file that the server generates
+    :param port: Port to serve (8000 usually)
+    :param domain: Domain to serve (i.e. localhost)
+    :param master_host: IP address to register the server to (if this runs in child mode)
+    :param master_port: Port to register the server to (if this runs in child mode)
+    :param username: Username to authenticate with
+    :param password: Password to authenticate with
+    :param is_master: Whether the server is master or not
+    :param secure: Whether the server is secure or not (if it looks for the certificates or not)
+    """
+
+    # find out my IP
+    host = get_my_ip()
+
+    print(f"""
+┏┓  • ┓┏┓  ┓┏┓ ({__VeraGridServer_VERSION__} Alpha) 
+┃┓┏┓┓┏┫┃ ┏┓┃┗┓┏┓┏┓┓┏┏┓┏┓
+┗┛┛ ┗┗┻┗┛┗┻┗┗┛┗ ┛ ┗┛┗ ┛
+{host}:{port}  
+    """)
+
+    if secure:
+        generate_ssl_certificate(
+            ip=host,
+            domain=domain,
+            key_file_name=key_file_name,
+            cert_file_name=cert_file_name
+        )
+
+    # extra attributed on launch
+    settings.am_i_master = is_master
+    settings.master_host = master_host
+    settings.master_port = master_port
+    settings.this_host = host
+    settings.this_port = port
+    settings.this_username = username
+    settings.this_password = password
+
+    if secure:
+        uvicorn.run(app,
+                    host=host, port=port, ssl_keyfile=key_file_name, ssl_certfile=cert_file_name)
+    else:
+        uvicorn.run(app,
+                    host=host, port=port)
+
+def str2bool(value):
+    if isinstance(value, bool):
+        return value
+    if value.lower() in {'True', 'true', 't', 'yes', '1'}:
+        return True
+    elif value.lower() in {'False', 'false', 'f', 'no', '0'}:
+        return False
+    else:
+        raise argparse.ArgumentTypeError(f'Invalid boolean value: {value}')
+
+if __name__ == "__main__":
+    # Initialize parser
+    parser = argparse.ArgumentParser(description="Start a secure VeraGrid server")
+
+    # Add arguments
+    parser.add_argument("--key_fname", type=str, default="key.pem",
+                        help="Path to the private key file that the server generates")
+    parser.add_argument("--cert_fname", type=str, default="cert.pem",
+                        help="Path to the certificate file that the server generates")
+    parser.add_argument("--host", type=str, default="0.0.0.0", help="Host IP address")
+    parser.add_argument("--port", type=int, default=8000, help="Port to run the server on")
+
+    parser.add_argument("--secure", type=str2bool,
+                        choices=[True, False], default=True, help="Use https?")
+
+    parser.add_argument("--master", type=str2bool,
+                        choices=[True, False], default=True, help="Use https?")
+
+    parser.add_argument("--master_host", type=str, default="0.0.0.0", help="URL of the master instance")
+    parser.add_argument("--master_port", type=int, default=80, help="Port of the master instance")
+    parser.add_argument("--user", type=str, default="", help="username")
+    parser.add_argument("--pwd", type=str, default="", help="Password")
+
+    # Parse arguments
+    args = parser.parse_args()
+
+    print("Arguments:")
+    print('\n'.join(f'{k}: {v}' for k, v in vars(args).items()))
+
+    # Call the start_server function with the parsed arguments
+    start_server(key_file_name=args.key_fname,
+                 cert_file_name=args.cert_fname,
+                 port=args.port,
+                 domain=args.host,
+                 master_host=args.master_host,
+                 master_port=args.master_port,
+                 secure=args.secure,
+                 is_master=args.master,
+                 username=args.user,
+                 password=args.pwd)

veragridserver-5.4.0/VeraGridServer/settings.py

@@ -0,0 +1,16 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+
+class ExtraSettings:
+    def __init__(self):
+        self.am_i_master: bool = True
+        self.master_host: str = ""
+        self.master_port = 0
+        self.this_port = 0
+        self.this_username = ""
+        self.this_password = ""
+
+
+settings = ExtraSettings()

veragridserver-5.4.0/setup.cfg

@@ -0,0 +1,3 @@
+[egg_info]
+tag_build = 
+tag_date = 0

veragridserver-5.4.0/setup.py

@@ -0,0 +1,105 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+"""
+A setuptools based setup module.
+See:
+https://packaging.python.org/guides/distributing-packages-using-setuptools/
+https://github.com/pypa/sampleproject
+"""
+
+# Always prefer setuptools over distutils
+from setuptools import setup, find_packages
+import os
+
+from VeraGridServer.__version__ import __VeraGridServer_VERSION__
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+long_description = """# VeraGrid
+
+This software aims to be a complete platform for power systems research and simulation.
+
+[Watch the video https](https://youtu.be/SY66WgLGo54)
+
+[Check out the documentation](https://gridcal.readthedocs.io)
+
+
+## Installation
+
+pip install VeraGridServer
+
+For more options (including a standalone setup one), follow the
+[installation instructions]( https://gridcal.readthedocs.io/en/latest/getting_started/install.html)
+from the project's [documentation](https://gridcal.readthedocs.io)
+"""
+
+description = 'VeraGrid is a Power Systems simulation program intended for professional use and research'
+
+base_path = os.path.join('VeraGridServer')
+
+pkgs_to_exclude = ['docs', 'research', 'tests', 'tutorials', 'VeraGridEngine']
+
+packages = find_packages(exclude=pkgs_to_exclude)
+
+# ... so we have to do the filtering ourselves
+packages2 = list()
+for package in packages:
+    elms = package.split('.')
+    excluded = False
+    for exclude in pkgs_to_exclude:
+        if exclude in elms:
+            excluded = True
+
+    if not excluded:
+        packages2.append(package)
+
+package_data = {'VeraGridServer': ['*.md',
+                                  '*.rst',
+                                  'LICENSE.txt',
+                                  'setup.py',
+                                  'data/VeraGrid_icon.ico'],
+                }
+
+dependencies = ['setuptools>=41.0.1',
+                'wheel>=0.37.2',
+                "fastapi",
+                "uvicorn",
+                "websockets",
+                "cryptography",
+                "VeraGridEngine==" + __VeraGridServer_VERSION__,  # the VeraGridEngine version must be exactly the same
+                ]
+
+extras_require = {
+    'gch5 files': ["tables"]  # this is for h5 compatibility
+}
+# Arguments marked as "Required" below must be included for upload to PyPI.
+# Fields marked as "Optional" may be commented out.
+
+setup(
+    name='VeraGridServer',  # Required
+    version=__VeraGridServer_VERSION__,  # Required
+    license='MPL2',
+    description=description,  # Optional
+    long_description=long_description,  # Optional
+    long_description_content_type='text/markdown',  # Optional (see note above)
+    url='https://github.com/SanPen/VeraGrid',  # Optional
+    author='Santiago Peñate Vera et. Al.',  # Optional
+    author_email='spenate@eroots.tech',  # Optional
+    classifiers=[
+        'Programming Language :: Python :: 3.8',
+    ],
+    keywords='power systems planning',  # Optional
+    packages=packages2,  # Required
+    include_package_data=True,
+    python_requires='>=3.8',
+    install_requires=dependencies,
+    extras_require=extras_require,
+    package_data=package_data,
+    entry_points={
+        'console_scripts': [
+            'gridcalserver = VeraGridServer.run:start_server',
+        ],
+    },
+)