Merge pull request #5 from Lab42-Team/dev

Dev

Author: LedZeppe1in

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lab42-Team
+
+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.

README.md

@@ -1,32 +1,80 @@
-# [ Home ](https://github.com/STI-Team/ontogen) / ontogen
-OnotoGen: Software system for analyzing and transforming spreadsheets into ontologies and related data sets
-This document describes the command-line interface for the <code>OntoGen(ont)</code> system.
+# OntoGen
 
-## Installation Instructions
+A command-line software called **OntoGen** for analysis and transformation of source spreadsheet data (CSV) to ontology (OWL/XML).
+
+## Version
+
+1.1
+
+## Preliminaries
+
+A source (input) spreadsheet represents a set of same type entities in a relational form (a subset of the Cartesian product of *K*-data domains), where:
+1.	*Attribute (a column name)* is a name of a data domain in a relationship schema;
+2.	*Metadata (a schema)* is an ordered set of *K*-attributes of a relational table;
+3.	*Tuple (a record)* is an ordered set of *K*-atomic values (one for each attribute of a relation);
+4.	*Data (a recordset)* is a set of tuples of a relational table.
+
+A spreadsheet of same type entities (*a canonicalized form*) is a relational table in the third normal form (3NF), which contains an ordered set of *N*-rows and *M*-columns.
+
+A table represents a set of entities of the same type, where:
+1.	*Categorical column or Named entities column (NE-column)* contains names (text mentions) of some named entities;
+2.	*Literal column (L-column)* contains literal values (e.g. dates, numbers);
+3.	*Subject (thematic) column (S-column)* is a *NE*-column represented as a potential primary key and defines a subject of a source table;
+4.	*Another (non-subject) columns* represent entity properties including their relationships with other entities.
+
+**Assumption 1.** *The first row of a source spreadsheet is a header containing attribute (column) names.*
+
+**Assumption 2.** *All values of column cells in a source spreadsheet have same entity types and data types.*
+
+**Assumption 3.** *Source spreadsheets should be presented in the CSV format.*
+
+**OntoGen** supports the process of ontology engineering based on spreadsheet data transformation.
+
+**Assumption 4.** *A target ontology is presented in the [OWL2 DL](https://www.w3.org/TR/owl2-overview/) format.*
+
+## Installation
+
+First, you need to clone the project into your directory:
 
-Run the following commands in order in a cmd.exe
 ```
-git clone https://github.com/STI-Team/ontogen
-cd ontogen
+git clone https://github.com/Lab42-Team/ontogen.git
+```
+
+Next, you need to install all requirements for this project:
 
-python3 -m venv ont_env
-ont_env\Scripts\activate.bat
-python.exe -m pip install --upgrade pip
+```
 pip install -r requirements.txt
 ```
-If python3 is not installed, find out what version of python 3 is installed and use that instead
-### Usage: python main.py [OPTIONS]
+
+*We recommend you to use Python 3.0 or more.*
+
+## Directory Structure
+
+* `datasets` contains datasets of source spreadsheets in the CSV format:
+    * `tough-tables` contains [Tough Tables (2T)](https://zenodo.org/record/4246370#.Yf5AO-pBw2w) dataset, where noise spreadsheets are excluded;
+    * `wiki-uku-49` contains spreadsheets describing the main concepts and relationships in the field of education, in particular, universities in the United Kingdom (see [wiki-UKU-49: United Kingdom Universities from Wikipedia](https://data.mendeley.com/datasets/33v9tk6jjb/1));
+    * `isi-167e` contains spreadsheets describing the main concepts and relationships in the field of Industrial Safety Inspection (see [ISI-167E: Entity spreadsheet tables](https://data.mendeley.com/datasets/3gjy46mx88/1)).
+* `examples` contains spreadsheet examples for testing.
+* `ontogen` contains software modules (py-scripts), including `main.py`.
+* `results` contains processing results (target ontologies).
+
+## Usage
+
+#### Usage: python main.py [OPTIONS]
 **Options:**
 - `--name=c:\userpath` -- Create ontologies
-### A Simple Example
+#### A simple example
 ```
-python main.py --name=f:\test
-
+python main.py --name=C:/test
 ```
 or
 
 ```
 python main.py
-Your path name: f:\test
-
+Your path to source spreadsheets: C:/test
 ```
+
+## Authors
+
+* [Daria A. Denisova](mailto:daryalich@mail.ru)
+* [Nikita O. Dorodnykh](mailto:tualatin32@mail.ru)

datasets/isi-167e/ISI_DataSet-10-15.csv

@@ -0,0 +1,2 @@
+Карта исходных данных,Программа работ по продлению срока безопасной эксплуатации (технического диагностирования),Акт готовности аппаратов к проведению технического диагностирования,Акт оперативной (функциональной) диагностики,Протокол проведения визуального и измерительного контроля 10-ВИК,Протокол проведения толщинометрии 10-УЗТ,Протокол и заключение акустико-эмиссионного контроля,Протокол проведения дефектоскопии 10-ПВК,Протокол проведения дефектоскопии 10-УЗК,Протокол измерения твердости 10-ТВ,Протоколы химического анализа,Расчет на прочность,Расчет остаточного ресурса,Перечень нормативной технической и методической документации использованной при экспертизе,Копия лицензии,Копия приказа,Копии удостоверений экспертов и специалистов
+на	6	листах,на	4	листах,на	1	листе,на	1	листе,на	4	листах,на 	1	листе,на 	1	листе,на 	1	листе,на 	1	листе,на 	1	листе,на	2	листах,на	3	листах,на	2	листах,на 	1	листе,на 	1	листе,на	2	листах,на 	1	листе

datasets/isi-167e/ISI_DataSet-10-59.csv

@@ -0,0 +1,11 @@
+Единца измерения,Наименование показателя,Результата испытаний,Регламентированное значение показателя для стали 40 по ГОСТ 1050-88
+%,С,0.41,0.37-0.45									
+%,Si,0.25,0.17-0.37									
+%,Mn,0.53,0.5-0.8	
+%,Cr,0.05,не более 0.25											
+%,Ni,0.06,не более 0.3								
+%,V,-,-						
+%,Mo,-,-								
+%,Cu,0.04,не более 0.3											
+%,P,0.023,не более 0.035				
+%,S,0.036,не более 0.035										

datasets/isi-167e/ISI_DataSet-10-61.csv

@@ -0,0 +1,11 @@
+Единца измерения, Наименование показателя,Результата испытаний,Регламентированное значение показателя для стали 40ХФА по ГОСТ 4543-71
+%,C,0.39,0.37-0.44
+%,Si,0.3,0.17-0.37
+%,Mn,0.8,0.5-0.8
+%,Cr,1.12,0.8-1.1
+%,Ni,0.11,не более 0.3
+%,V,0.18,0.1-0.18
+%,Mo,-,-
+%,Cu,0.12,не более 0.3
+%,P,0.022,не более 0.025
+%,S,0.025,не более 0.025

datasets/isi-167e/ISI_DataSet-10-f1-17.csv

@@ -0,0 +1,5 @@
+Наименование элемента,	Кол-во шт.,Размеры Диаметр внутренний,Размеры Толщина стенки,Размеры Длина (высота),Материал Марка,Материал Гост или ТУ	
+корпус,1,1000,130,6000,немецкая сталь - аналог сталь 25,-
+крышка	2	Дн = 920	280	-		
+шпилька	16	W94x1/4''	-	640	немецкая таль CrNiMo	-
+гайка	16	W94x1/4''	-	100	немецкая сталь S3 - аналог сталь 40	

datasets/isi-167e/ISI_DataSet-10-f1-19-2.csv

@@ -0,0 +1,5 @@
+Обозначение,Назначение,Кол. шт.,Условный переход мм,Условное давление МПа,Место установки,Материал Марка,Материал ГОСТ или ТУ
+А,вход газа	1,90,32,крышка нижняя,-,-
+Б,выход газа,1,90,32,крышка верхняя,-,-
+В,под уровнемер,2,15,32,корпус,-,-
+Г,выход конденсата,1,40,32,корпус,-,-

datasets/isi-167e/ISI_DataSet-10-f1-19-5.csv

@@ -0,0 +1,6 @@
+Давление МПа,проектные,фактические
+рабочее,32.5,32
+расчетно,32.5,32
+разрешенное,32.5,32
+пробное гидроиспытания,42.5,40
+настройка предохранительного клапана,-,-

datasets/isi-167e/ISI_DataSet-10-f1-19.csv

@@ -0,0 +1,4 @@
+Название элемента,Химический состав % С,Химический состав % Si,Химический состав % Mn,Химический состав % P,Химический состав % S,Химический состав % Cr,Химический состав % Ni,Химический состав % Mo,Химический состав % V,Химический состав % W,Механические свойства Gt_20 МПа,Механические свойства Gt_20 МПа,Механические свойства аН,Механические свойства b %,Примечание
+корпус,0.25,0.31,0.6,0.036,0.031,-,-,-,-,-,360,540,-,-,137-154
+крышка верхняя,0.26,0.2,0.51,0.033,0.019,-,-,-,-,-,230,420,-,-,151
+крышка нижняя,0.26,0.18,0.51,0.022,0.024,-,-,-,-,-,230,420,-,-,151

datasets/isi-167e/ISI_DataSet-10-f1-21-2.csv

@@ -0,0 +1,2 @@
+наименование элемента сосуда (аппарата),проектная толщина мм,фактическая минимальная толщина мм,организация проводившая контроль; номер и дата протокола
+корпус,130,126.9,ОАО Рога и Копыта Прот. 10-УЗТ от 12.12.12 заключение 10-1 от 12.12.12