vxformsapi is a Python library to enable a high-level interaction with the VxForms Material's API without the need of the VXForms Materials's Website.
The project is being developed in association with University of Aveiro - Portugal, and it is currently mantained by the research grant team.
vxformsapi automatically installs the following dependencies:
pip install vxformsapi
Some methods will require the login_token argument to allow for permissions or uploads. There are 2 ways to obtain the token:
from vxformsapi.API import *
login_token = authenticate("username_value", "password_value")
# Uses hardcoded information.
# Not recommended if the script is associated with a repository for security reasons.
login_token_json = authenticate_from_json("json_filename.json")
# Recommended approach for security.
# Uses information provided in the json file that follows the following structure:
# {
# username: "username_value",
# password: "password_value"
# }
The login_token can now be used in any necessary method passing it as an argument.
from vxformsapi.API import *
token = authenticate_from_json("secrets.json")
# Creating a material
thermal_expansion_coef = {
"20": 1.15,
"200": 1.27,
"300": 1.32
}
specific_heat_capacity = {
"20": 430,
"200": 499,
"300": 517
}
thermal_conductivity = {
"20": 34.9,
"200": 38,
"300": 37.8
}
tp = ThermalProperties(thermal_expansion_coef=thermal_expansion_coef, specific_heat_capacity=specific_heat_capacity,
thermal_conductivity=thermal_conductivity)
elastic_modulus = {
"-100": 217,
"20": 214,
"200": 202,
"300": 192
}
poissons_ratio = {
"20": 0.283,
"200": 0.292,
"300": 0.294
}
shear_modulus = {
"20": 82.8,
"200": 77.9,
"300": 74.9
}
yield_strength = {
"20": 280,
"200": 224,
"300": 221
}
mp = MechanicalProperties(tensile_strength=500, thermal_conductivity=46.8, reduction_of_area=41.4, cyclic_yield_strength=250,
elastic_modulus=elastic_modulus, poissons_ratio=poissons_ratio, shear_modulus=shear_modulus,
yield_strength=yield_strength)
chemical_composition = {
"C": 0.105,
"Si": 0.24,
"Mn": 0.43,
"P": 0.012,
"S": 0.014,
"Cr": 2.29,
"Mo": 1.004,
"Ni": 0.16,
"Cu": 0.9,
"Ti": 0.03,
"V": 0.02,
"Al": 0.02
}
pp = PhysicalProperties(chemical_composition=chemical_composition)
category = get_category_by_name("Alloy Steel")
material = Material(name="EN 10028-2 Grade 10CrMo9-10 normalized and tempered (+NT)", category=category,
source="Boller C, Seeger T. Materials data for cyclic loading, Part B. Amsterdam: Elsevier; 1987",
designation="DIN 10 CrMo 9 10", heat_treatment="Normalized & tempered, 950°C/30min air, 750°C/2h air",
thermal_properties=tp, mechanical_properties=mp, physical_properties=pp)
material.register(token)
# Fetching the stored materials
for material in get_materials():
print(material.id, material.name, material.submitted_by, material.date, material.user)
from vxformsapi.API import *
token = authenticate_from_json("secrets.json")
# Creating a test
# ID of the material which the new test refers to
material = get_material(3)
# Test metadata
metadata = {
"param1": "Some value",
"param2": 10.4,
"param3": 5,
"xyz": 34.6
}
# No need to be the material owner
test = Test(material, "Test Name", metadata)
test.register(token)
# Fetch all tests
for test in get_tests():
print(test.id, test.name)
from vxformsapi.API import *
import os
token = authenticate_from_json("secrets.json")
# Directory where the DIC files and load data are stored, consult the user manual for formatting and naming of the files
dir = "DIC_files\\"
# ID of the test we wish to populate
test_id = 3
f = []
for (dirpath, dirnames, filenames) in os.walk(dir):
f.extend(filenames)
break
file_mappings = {name : open(dir+name, "rb") for name in f}
test = get_test(test_id)
# Upload the data
test.upload_test_data(token, file_mappings, file_format=UploadFileFormat.MatchId, _3d=False)
# Download the data as a ZIP file
test.download_test_data()
# Download the data as a pandas dataframe
stages_df = test.load_test_data()
print(stages_df.keys())
print(stages_df[2])
from vxformsapi.API import *
token = authenticate_from_json("secrets.json")
material = get_material(2)
material_parameter = MaterialParam("Material Parameter Name", material)
register_material_param(token, material_parameter)
from vxformsapi.API import *
yield_locus = get_model(7)
hard = get_model(8)
elastic = get_model(9)
material_param = get_material_param(2)
# Inputs will vary accordingly to the model
locus_params = {"f": 0.3748, "h": 0.4709, "g": 1 - 0.4709, "n": 1.1125}
params3 = ModelParams(yield_locus, material_param, locus_params)
hard_params = {"k": 979.46, "eps0": 0.00535, "swift_n": 0.194}
params4 = ModelParams(hard, material_param, hard_params)
elastic_params = {"multiplier": 1.0}
params5 = ModelParams(elastic, material_param, elastic_params)
params3 = register_model_params(token, params3)
params4 = register_model_params(token, params4)
params5 = register_model_params(token, params5)
get_materials: Retrieve a page of materials.
Parameters
----------
page (optional) : int
Page number
page_size (optional) : int
Number of materials per page
ordering (optional) : MaterialOrderings
Ordering of the material list (available orderings: id, date, name, upper/middle/lower_category)
ascending (optional) : bool
Defines ordering direction
search (optional) : str
Filters materials by inclusion of the specified string in the material name or description
get_material: Retrieve a material by id.
Parameters
----------
material_id : int
The id of the material to be fetched
register_material: Save a material to the database.
Parameters
----------
material : Material
The material to be saved (name must be unique)
login_token : str
The log-in token that can be retrieved from the authenticate function
get_categories: Retrieve all categories.
Parameters
----------
mode (optional) : CategoriesDisplayModes
Either return the categories in a tree-like object or return three lists for each type of category (upper, middle, lower)
get_category: Retrieve a category by id.
Parameters
----------
category_id : int
The id of the category to be fetched
level (optional) : CategoryLevel
The level of the category to be fetched (by default, lower)
get_category_by_name: Retrieve a category by name.
Parameters
----------
category_name : str
The name of the category to be fetched
level (optional) : CategoryLevel
The level of the category to be fetched (by default, lower)
register_category: Save a category to the database.
Parameters
----------
admin_token : str
The log-in token that can be retrieved from the authenticate function (must be admin)
category : Category
The category to be saved
register_test: Save a test to the database.
Parameters
----------
login_token : str
The log-in token that can be retrieved from the authenticate function
test : Test
The test to be saved (name must be unique within the material's tests)
get_tests: Retrieve a page of tests.
Parameters
----------
page (optional) : int
Page number
page_size (optional) : int
Number of tests per page
material (optional) : int
Filter by material (id)
submitted_by (optional) : int
Filter by user (id)
get_test: Retrieve a test by id.
Parameters
----------
test_id : int
The id of the test to be fetched
get_model: Retrieve a model by id.
Parameters
----------
model_id : int
The id of the model to be fetched
register_model: Save a model to the database.
Parameters
----------
admin_token : str
The log-in token that can be retrieved from the authenticate function (must be admin)
model : Model
The model to be saved
get_model_params: Retrieve model parameters by id.
Parameters
----------
modelp_id : int
The id of the model parameters to be fetched
register_model_params: Save model parameters to the database.
Parameters
----------
login_token : str
The log-in token that can be retrieved from the authenticate function
modelp : ModelParams
The model parameters to be saved
get_material_param: Retrieve material parameters by id.
Parameters
----------
materialp_id : int
The id of the material parameters to be fetched
register_material_param: Save material parameters to the database.
Parameters
----------
login_token : str
The log-in token that can be retrieved from the authenticate function
materialp : MaterialParam
The material parameter to be saved
id : int
submitted_by : int
user : str
date : str
name : str
category : LowerCategory
source : str
designation : str
heat_treatment : str
description : str
thermal_properties : dict
mechanical_properties : dict
physical_properties : dict
id : int
material : int
name : str
metadata : dict
submitted_by : str
id : int
name : str
tag : str
function_name : str
input : list[str]
category : Category
id : int
name : str
submitted_by : int
material : int
id : int
submitted_by : int
material_param : int
model : int
params : dict[str, float]
MaterialOrderings(Id, Date, Name, UpperC, MiddleC, LowerC)CategoriesDisplayModes(Tree, List)CategoryLevel(Upper, Middle, Lower)UploadFileFormat(MatchId, Aramis)FAQs
API for the VxForms Material Database.
We found that vxformsapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.