+ 
+
+
+
+ 
+
+
+
+"""Python implementation of the gRPC API Eigen Example client."""
+
+import grpc
+import numpy as np
+
+import ansys.eigen.python.grpc.constants as constants
+import ansys.eigen.python.grpc.generated.grpcdemo_pb2 as grpcdemo_pb2
+import ansys.eigen.python.grpc.generated.grpcdemo_pb2_grpc as grpcdemo_pb2_grpc
+
+
+
+[docs]
+class DemoGRPCClient:
+ """Provides the API Eigen Example client class for interacting via gRPC."""
+
+ def __init__(self, ip="127.0.0.1", port=50051, timeout=1, test=None):
+ """Initialize connection to the API Eigen server.
+
+ Parameters
+ ----------
+ ip : str, optional
+ IP or DNS to which to connect. The default is "127.0.0.1".
+ port : int, optional
+ Port to connect to. The default is 50051.
+ timeout : int, optional
+ Number of seconds to wait before returning a timeout in the connection. The default is 1.
+ test : object, optional
+ Test GRPCDemoStub to connect to. The default is ``None``. This argument is only intended for test purposes.
+
+ Raises
+ ------
+ IOError
+ Error if the client was unable to connect to the server.
+ """
+ # For test purposes, provide a stub directly
+ if test is not None:
+ self._stub = test
+ return
+
+ self._stub = None
+ self._channel_str = "%s:%d" % (ip, port)
+
+ self.channel = grpc.insecure_channel(self._channel_str)
+
+ # Verify connection
+ try:
+ grpc.channel_ready_future(self.channel).result(timeout=timeout)
+ except grpc.FutureTimeoutError:
+ raise IOError("Unable to connect to server at %s" % self._channel_str)
+
+ # Set up the stub
+ self._stub = grpcdemo_pb2_grpc.GRPCDemoStub(self.channel)
+
+ print("Connected to server at %s:%d" % (ip, port))
+
+ # =================================================================================================
+ # PUBLIC METHODS for Client operations
+ # =================================================================================================
+
+
+[docs]
+ def request_greeting(self, name):
+ """Method that requests a greeting from the server.
+
+ Parameters
+ ----------
+ name : str
+ Name of the "client". For example, "Michael".
+ """
+ # Build the greeting request
+ request = grpcdemo_pb2.HelloRequest(name=name)
+
+ # Send the request
+ response = self._stub.SayHello(request)
+
+ # Show the server's response
+ print("The server answered: " + response.message)
+
+
+
+[docs]
+ def flip_vector(self, vector):
+ """Flip the position of a numpy.ndarray vector such that [A, B, C, D] --> [D, C, B, A].
+
+ Parameters
+ ----------
+ vector : numpy.ndarray
+ Vector to flip.
+
+ Returns
+ -------
+ numpy.ndarray
+ Flipped vector.
+ """
+ # Generate the metadata and the amount of chunks per vector
+ md, chunks = self._generate_md("vectors", "vec", vector)
+
+ # Build the stream (i.e. generator)
+ vector_gen = self._generate_vector_stream(chunks, vector)
+
+ # Call the server method and retrieve the result
+ response_iterator = self._stub.FlipVector(vector_gen, metadata=md)
+
+ # Now, convert to a numpy.ndarray to continue nominal operations (outside the client)
+ nparray = self._read_nparray_from_vector(response_iterator)
+
+ # Return only the first element (expecting a single vector)
+ return nparray[0]
+
+
+
+[docs]
+ def add_vectors(self, *args):
+ """Add numpy.ndarray vectors using the Eigen library on the server side.
+
+ Returns
+ -------
+ numpy.ndarray
+ Result of the given numpy.ndarrays.
+ """
+ # Generate the metadata and the amount of chunks per vector
+ md, chunks = self._generate_md("vectors", "vec", *args)
+
+ # Build the stream (i.e. generator)
+ vector_iterator = self._generate_vector_stream(chunks, *args)
+
+ # Call the server method and retrieve the result
+ response_iterator = self._stub.AddVectors(vector_iterator, metadata=md)
+
+ # Now, convert to a numpy.ndarray to continue nominal operations (outside the client)
+ nparray = self._read_nparray_from_vector(response_iterator)
+
+ # Return only the first element (expecting a single vector)
+ return nparray[0]
+
+
+
+[docs]
+ def multiply_vectors(self, *args):
+ """Multiply numpy.ndarray vectors using the Eigen library on the server side.
+
+ Returns
+ -------
+ numpy.ndarray
+ Result of the multiplication of numpy.ndarray vectors. Despite returning a numpy.ndarray, the result only contains one value because it is a dot product.
+ """
+ # Generate the metadata and the amount of chunks per vector
+ md, chunks = self._generate_md("vectors", "vec", *args)
+
+ # Build the stream (generator)
+ vector_iterator = self._generate_vector_stream(chunks, *args)
+
+ # Call the server method and retrieve the result
+ response_iterator = self._stub.MultiplyVectors(vector_iterator, metadata=md)
+
+ # Convert to a numpy.ndarray to continue nominal operations (outside the client)
+ nparray = self._read_nparray_from_vector(response_iterator)
+
+ # Return only the first element (expecting a single vector)
+ return nparray[0]
+
+
+
+[docs]
+ def add_matrices(self, *args):
+ """Add numpy.ndarray matrices using the Eigen library on the server side.
+
+ Returns
+ -------
+ numpy.ndarray
+ Resulting numpy.ndarray of the matrices addition.
+ """
+ # Generate the metadata and the amount of chunks per Matrix
+ md, chunks = self._generate_md("matrices", "mat", *args)
+
+ # Build the stream (i.e. generator)
+ matrix_iterator = self._generate_matrix_stream(chunks, *args)
+
+ # Call the server method and retrieve the result
+ response_iterator = self._stub.AddMatrices(matrix_iterator, metadata=md)
+
+ # Now, convert to a numpy.ndarray to continue nominal operations (outside the client)
+ nparray = self._read_nparray_from_matrix(response_iterator)
+
+ # Return only the first element (expecting a single matrix)
+ return nparray[0]
+
+
+
+[docs]
+ def multiply_matrices(self, *args):
+ """Multiply numpy.ndarray matrices using the Eigen library on the server side.
+
+ Returns
+ -------
+ numpy.ndarray
+ Resulting numpy.ndarray of the matrices' multiplication.
+ """
+ # Generate the metadata and the amount of chunks per matrix
+ md, chunks = self._generate_md("matrices", "mat", *args)
+
+ # Build the stream (i.e. generator)
+ matrix_iterator = self._generate_matrix_stream(chunks, *args)
+
+ # Call the server method and retrieve the result
+ response_iterator = self._stub.MultiplyMatrices(matrix_iterator, metadata=md)
+
+ # Convert to a numpy.ndarray to continue nominal operations (outside the client)
+ nparray = self._read_nparray_from_matrix(response_iterator)
+
+ # Return only the first element (expecting a single matrix)
+ return nparray[0]
+
+
+ # =================================================================================================
+ # PRIVATE METHODS for Client operations
+ # =================================================================================================
+
+ def _generate_md(self, message_type: str, abbrev: str, *args: np.ndarray):
+ # Initialize the metadata and the chunks list for each full message
+ md = []
+ chunks = []
+
+ # Find how many arguments are transmitting
+ md.append(("full-" + message_type, str(len(args))))
+
+ # Loop over all input arguments
+ idx = 1
+ for arg in args:
+ # Perform some argument input sanity checks
+ if message_type == "vectors" and abbrev == "vec":
+ self._sanity_check_vector(arg)
+ elif message_type == "matrices" and abbrev == "mat":
+ self._sanity_check_matrix(arg)
+ else:
+ raise RuntimeError("Invalid usage of _generate_md function.")
+
+ # Check the size of the arrays
+ # If size is surpassed, determine chunks needed
+ if arg.nbytes > constants.MAX_CHUNKSIZE:
+ # Determine how many chunks are needed
+ #
+ # Max amount of elements per chunk
+ max_elems = constants.MAX_CHUNKSIZE // arg.itemsize
+
+ # Bulk number of chunks needed
+ bulk_chunks = arg.size // max_elems
+
+ # The remainder amount of elements (if any)
+ remainder = arg.size % max_elems
+
+ # This list provides the last index up to which to
+ # process in each partial vector or matrix message
+ last_idx_chunk = []
+ for i in range(1, bulk_chunks + 1):
+ last_idx_chunk.append(i * max_elems)
+
+ # Take into account that if there is a remainder, include
+ # one last partial vector or matrix message
+ if remainder != 0:
+ last_idx_chunk.append(arg.size)
+
+ # Append the results
+ md.append((abbrev + str(idx) + "-messages", str(len(last_idx_chunk))))
+ chunks.append(last_idx_chunk)
+
+ else:
+ # Otherwise deal with a single message... Append results.
+ md.append((abbrev + str(idx) + "-messages", str(1)))
+ chunks.append([arg.size])
+
+ # Increase idx by 1
+ idx += 1
+
+ # Return the metadata and the chunks list for each vector or matrix
+ return md, chunks
+
+ def _generate_vector_stream(self, chunks: "list[list[int]]", *args: np.ndarray):
+ # Loop over all input arguments
+ for arg, vector_chunks in zip(args, chunks):
+ # Perform some argument input sanity checks
+ self._sanity_check_vector(arg)
+
+ # If sanity checks are fine... yield the corresponding vector message
+ #
+ # Loop over the chunk indices
+ processed_idx = 0
+ for last_idx_chunk in vector_chunks:
+ # Use tmp_idx in yield function and update the processed_idx afterwards
+ tmp_idx = processed_idx
+ processed_idx = last_idx_chunk
+
+ # Yield!
+ yield grpcdemo_pb2.Vector(
+ data_type=constants.NP_DTYPE_TO_DATATYPE[arg.dtype.type],
+ vector_size=arg.shape[0],
+ vector_as_chunk=arg[tmp_idx:last_idx_chunk].tobytes(),
+ )
+
+ def _generate_matrix_stream(self, chunks: "list[list[int]]", *args: np.ndarray):
+ # Loop over all input arguments
+ for arg, matrix_chunks in zip(args, chunks):
+ # Perform some argument input sanity checks.
+ self._sanity_check_matrix(arg)
+
+ # If sanity checks are fine... yield the corresponding matrix message
+ #
+ # When dealing with matrices, ravel it to a 1D array (avoids copy)
+ arg_as_vec = arg.ravel()
+
+ # Loop over the chunk indices
+ processed_idx = 0
+ for last_idx_chunk in matrix_chunks:
+ # Use tmp_idx in yield function and update the processed_idx afterwards
+ tmp_idx = processed_idx
+ processed_idx = last_idx_chunk
+
+ # Yield
+ yield grpcdemo_pb2.Matrix(
+ data_type=constants.NP_DTYPE_TO_DATATYPE[arg.dtype.type],
+ matrix_rows=arg.shape[0],
+ matrix_cols=arg.shape[1],
+ matrix_as_chunk=arg_as_vec[tmp_idx:last_idx_chunk].tobytes(),
+ )
+
+ def _read_nparray_from_vector(self, response_iterator):
+ # Get the metadata
+ response_md = response_iterator.initial_metadata()
+
+ # Parse the server's metadata
+ full_msg, chunks_per_msg = self._parse_server_metadata(response_md)
+
+ # Initialize the output list
+ resulting_vectors = []
+
+ # Start processing messages independently
+ for msg in range(full_msg):
+ # Init the resulting numpy.ndarray to None, its size and its type
+ result = None
+ result_size = 0
+ result_dtype = None
+
+ # Loop over the available chunks per message
+ for chunk_idx in range(chunks_per_msg[msg]):
+ # Read a message
+ vector = next(response_iterator)
+
+ # If it is the first chunk being processed, parse dtype and size
+ if chunk_idx == 0:
+ if vector.data_type == grpcdemo_pb2.DataType.Value("INTEGER"):
+ result_dtype = np.int32
+ elif vector.data_type == grpcdemo_pb2.DataType.Value("DOUBLE"):
+ result_dtype = np.float64
+
+ result_size = vector.vector_size
+
+ # Parse the chunk
+ if result is None:
+ result = np.frombuffer(vector.vector_as_chunk, dtype=result_dtype)
+ else:
+ tmp = np.frombuffer(vector.vector_as_chunk, dtype=result_dtype)
+ result = np.concatenate((result, tmp))
+
+ # Check if the final vector has the desired size
+ if result.size != result_size:
+ raise RuntimeError("Problems reading server full Vector message...")
+ else:
+ # If everything is fine, append to resulting_vectors list
+ resulting_vectors.append(result)
+
+ # Return the resulting_vectors list
+ return resulting_vectors
+
+ def _read_nparray_from_matrix(self, response_iterator):
+ # Get the metadata
+ response_md = response_iterator.initial_metadata()
+
+ # Parse the server's metadata
+ full_msg, chunks_per_msg = self._parse_server_metadata(response_md)
+
+ # Initialize the output list
+ resulting_matrices = []
+
+ # Start processing messages independently
+ for msg in range(full_msg):
+ # Init the resulting numpy.ndarray to None, its size (rows,cols), and its type
+ result = None
+ result_rows = 0
+ result_cols = 0
+ result_dtype = None
+
+ # Loop over the available chunks per message
+ for chunk_idx in range(chunks_per_msg[msg]):
+ # Read a message
+ matrix = next(response_iterator)
+
+ # If it is the first chunk being processing, parse dtype and size (rows,cols)
+ if chunk_idx == 0:
+ if matrix.data_type == grpcdemo_pb2.DataType.Value("INTEGER"):
+ result_dtype = np.int32
+ elif matrix.data_type == grpcdemo_pb2.DataType.Value("DOUBLE"):
+ result_dtype = np.float64
+
+ result_rows = matrix.matrix_rows
+ result_cols = matrix.matrix_cols
+
+ # Parse the chunk
+ if result is None:
+ result = np.frombuffer(matrix.matrix_as_chunk, dtype=result_dtype)
+ else:
+ tmp = np.frombuffer(matrix.matrix_as_chunk, dtype=result_dtype)
+ result = np.concatenate((result, tmp))
+
+ # Check if the final matrix has the desired size
+ if result.size != result_rows * result_cols:
+ raise RuntimeError("Problems reading server full matrix message...")
+ else:
+ # If everything is fine, append to resulting_matrices list
+ resulting_matrices.append(
+ np.reshape(
+ result,
+ (
+ result_rows,
+ result_cols,
+ ),
+ )
+ )
+
+ # Return the resulting_matrices list
+ return resulting_matrices
+
+ def _sanity_check_vector(self, arg):
+ # Perform some argument input sanity checks.
+ if type(arg) is not np.ndarray:
+ raise RuntimeError("Invalid argument. Only numpy.ndarrays are allowed.")
+ elif arg.dtype.type not in constants.NP_DTYPE_TO_DATATYPE.keys():
+ raise RuntimeError(
+ "Invalid argument. Only numpy.ndarrays of type int32 and float64 are allowed."
+ )
+ elif arg.ndim != 1:
+ raise RuntimeError("Invalid argument. Only 1D numpy.ndarrays are allowed.")
+
+ def _sanity_check_matrix(self, arg):
+ # Perform some argument input sanity checks.
+ if type(arg) is not np.ndarray:
+ raise RuntimeError("Invalid argument. Only numpy.ndarrays are allowed.")
+ elif arg.dtype.type not in constants.NP_DTYPE_TO_DATATYPE.keys():
+ raise RuntimeError(
+ "Invalid argument. Only numpy.ndarrays of type int32 and float64 are allowed."
+ )
+ elif arg.ndim != 2:
+ raise RuntimeError("Invalid argument. Only 2D numpy.ndarrays are allowed.")
+
+ def _parse_server_metadata(self, response_md: "list[tuple]"):
+ # Init the return variables: amount of full messages received
+ # and partial messages per full message
+ full_msg = 0
+ chunks_per_msg = []
+
+ # Find out how many full messages are to be processed
+ for md in response_md:
+ if md[0] == "full-vectors" or md[0] == "full-matrices":
+ full_msg = int(md[1])
+
+ # Identify the chunks per message (only if successful previously)
+ if full_msg != 0:
+ for i in range(1, full_msg + 1):
+ for md in response_md:
+ if md[0] == "vec%d-messages" % i or md[0] == "mat%d-messages" % i:
+ chunks_per_msg.append(int(md[1]))
+
+ return full_msg, chunks_per_msg
+
+
+
+
+
+
+"""Python implementation of the gRPC API Eigen example server."""
+
+from concurrent import futures
+import logging
+
+import click
+import demo_eigen_wrapper
+import grpc
+import numpy as np
+
+import ansys.eigen.python.grpc.constants as constants
+import ansys.eigen.python.grpc.generated.grpcdemo_pb2 as grpcdemo_pb2
+import ansys.eigen.python.grpc.generated.grpcdemo_pb2_grpc as grpcdemo_pb2_grpc
+
+# =================================================================================================
+# AUXILIARY METHODS for Server operations
+# =================================================================================================
+
+
+
+[docs]
+def check_data_type(dtype, new_dtype):
+ """Check if the new data type is the same as the previous data type.
+
+ Parameters
+ ----------
+ dtype : numpy.type
+ Type of the numpy array before processing.
+ new_dtype : numpy.type
+ Type of the numpy array to be processed.
+
+ Returns
+ -------
+ numpy.type
+ Type of the numpy array.
+
+ Raises
+ ------
+ RuntimeError
+ In case there is already a type and it does not match that of the new_type argument.
+ """
+ if dtype is None:
+ return new_dtype
+ elif dtype != new_dtype:
+ raise RuntimeError(
+ "Error while processing data types... Input arguments are of different nature (such as int32, float64)."
+ )
+ else:
+ return dtype
+
+
+
+
+[docs]
+def check_size(size, new_size):
+ """Check if the new parsed size is the same as the previous size.
+
+ Parameters
+ ----------
+ size : tuple
+ Size of the numpy array before processing.
+ new_size : _type_
+ Size of the numpy array to process.
+
+ Returns
+ -------
+ tuple
+ Size of the numpy array.
+
+ Raises
+ ------
+ RuntimeError
+ In case there is already a size and it does not match that of the new_size argument.
+ """
+ if size is None:
+ return new_size
+ elif size != new_size:
+ raise RuntimeError(
+ "Error while processing data types... Input arguments are of different sizes."
+ )
+ else:
+ return size
+
+
+
+
+[docs]
+class GRPCDemoServicer(grpcdemo_pb2_grpc.GRPCDemoServicer):
+ """Provides methods that implement functionality of the API Eigen Example server."""
+
+ def __init__(self) -> None:
+ """No special init is required for the server... unless data is to be stored in a DB. This is to be determined."""
+ # TODO : is it required to store the input vectors in a DB?
+ super().__init__()
+
+ # =================================================================================================
+ # PUBLIC METHODS for Server operations
+ # =================================================================================================
+
+
+[docs]
+ def SayHello(self, request, context):
+ """Test the greeter method to see if the server is up and running correctly.
+
+ Parameters
+ ----------
+ request : HelloRequest
+ Greeting request sent by the client.
+ context : grpc.ServicerContext
+ gRPC-specific information.
+
+ Returns
+ -------
+ grpcdemo_pb2.HelloReply
+ Reply to greeting by the server.
+ """
+ click.echo("Greeting requested! Requested by: " + request.name)
+
+ # Inform about the size of the message content
+ click.echo("Size of message: " + constants.human_size(request))
+
+ return grpcdemo_pb2.HelloReply(message="Hello, %s!" % request.name)
+
+
+
+[docs]
+ def FlipVector(self, request_iterator, context):
+ """Flip a given vector.
+
+ Parameters
+ ----------
+ request_iterator : iterator
+ Iterator to the stream of vector messages provided.
+ context : grpc.ServicerContext
+ gRPC-specific information.
+
+ Returns
+ -------
+ grpcdemo_pb2.Vector
+ Flipped vector message.
+ """
+ click.echo("Vector flip requested.")
+
+ # Process the metadata
+ md = self._read_client_metadata(context)
+
+ # Process the input messages
+ dtype, size, vector_list = self._get_vectors(request_iterator, md)
+
+ # Flip it --> assuming that only one vector is passed
+ nparray_flipped = np.flip(vector_list[0])
+
+ # Send the response
+ return self._send_vectors(context, nparray_flipped)
+
+
+
+[docs]
+ def AddVectors(self, request_iterator, context):
+ """Add vectors.
+
+ Parameters
+ ----------
+ request_iterator : iterator
+ Iterator to the stream of vector messages provided.
+ context : grpc.ServicerContext
+ gRPC-specific information.
+
+ Returns
+ -------
+ grpcdemo_pb2.Vector
+ Vector message.
+ """
+ click.echo("Vector addition requested.")
+ # Process the metadata
+ md = self._read_client_metadata(context)
+
+ # Process the input messages
+ dtype, size, vector_list = self._get_vectors(request_iterator, md)
+
+ # Create an empty array with the input arguments characteristics (dtype, size)
+ result = np.zeros(size, dtype=dtype)
+
+ # Add all provided vectors using the Eigen library
+ for vector in vector_list:
+ # Casting is needed due to interface with Eigen library... Not the desired approach,
+ # but works. Ideally, vectors should be passed directly, but errors appear
+ cast_vector = np.array(vector, dtype=dtype)
+ result = demo_eigen_wrapper.add_vectors(result, cast_vector)
+
+ # Send the response
+ return self._send_vectors(context, result)
+
+
+
+[docs]
+ def MultiplyVectors(self, request_iterator, context):
+ """Multiply two vectors.
+
+ Parameters
+ ----------
+ request_iterator : iterator
+ Iterator to the stream of vector messages provided.
+ context : grpc.ServicerContext
+ gRPC-specific information.
+
+ Returns
+ -------
+ grpcdemo_pb2.Vector
+ Vector message.
+ """
+ click.echo("Vector dot product requested")
+
+ # Process the metadata
+ md = self._read_client_metadata(context)
+
+ # Process the input messages
+ dtype, size, vector_list = self._get_vectors(request_iterator, md)
+
+ # Check that the vctor list contains a maximum of two vectors
+ if len(vector_list) != 2:
+ raise RuntimeError(
+ "Unexpected number of vectors to be multiplied: "
+ + len(vector_list)
+ + ". Only 2 is valid."
+ )
+
+ # Perform the dot product of the provided vectors using the Eigen library
+ # casting is needed due to interface with Eigen library... Not the desired approach,
+ # but works. Ideally, vectors should be passed directly, but errors appear
+ vec_1 = np.array(vector_list[0], dtype=dtype)
+ vec_2 = np.array(vector_list[1], dtype=dtype)
+ result = demo_eigen_wrapper.multiply_vectors(vec_1, vec_2)
+
+ # Return the result as a numpy.ndarray
+ result = np.array(result, dtype=dtype, ndmin=1)
+
+ # Finally, send the response
+ return self._send_vectors(context, result)
+
+
+
+[docs]
+ def AddMatrices(self, request_iterator, context):
+ """Add matrices.
+
+ Parameters
+ ----------
+ request_iterator : iterator
+ Iterator to the stream of matrix messages provided.
+ context : grpc.ServicerContext
+ gRPC-specific information.
+
+ Returns
+ -------
+ grpcdemo_pb2.Matrix
+ Matrix message.
+ """
+ click.echo("Matrix addition requested!")
+ # Process the metadata
+ md = self._read_client_metadata(context)
+
+ # Process the input messages
+ dtype, size, matrix_list = self._get_matrices(request_iterator, md)
+
+ # Create an empty array with the input arguments characteristics (dtype, size)
+ result = np.zeros(size, dtype=dtype)
+
+ # Add all provided matrices using the Eigen library
+ for matrix in matrix_list:
+ # Casting is needed due to interface with Eigen library... Not the desired approach,
+ # but works. Ideally, we would want to pass matrix directly, but errors appear
+ cast_matrix = np.array(matrix, dtype=dtype)
+ result = demo_eigen_wrapper.add_matrices(result, cast_matrix)
+
+ # Send the response
+ return self._send_matrices(context, result)
+
+
+
+[docs]
+ def MultiplyMatrices(self, request_iterator, context):
+ """Multiply two matrices.
+
+ Parameters
+ ----------
+ request_iterator : iterator
+ Iterator to the stream of Matrix messages provided.
+ context : grpc.ServicerContext
+ gRPC-specific information.
+
+ Returns
+ -------
+ grpcdemo_pb2.Matrix
+ Matrix message.
+ """
+ click.echo("Matrix multiplication requested.")
+
+ # Process the metadata
+ md = self._read_client_metadata(context)
+
+ # Process the input messages
+ dtype, size, matrix_list = self._get_matrices(request_iterator, md)
+
+ # Check that the matrix list contains a maximum of two matrices
+ if len(matrix_list) != 2:
+ raise RuntimeError(
+ "Unexpected number of matrices to be multiplied: "
+ + len(matrix_list)
+ + ". You can only multiple two matrices."
+ )
+
+ # Due to the previous _get_matrices method, the size of all
+ # matrices is the same... check that it is a square matrix. Otherwise, no multiplication
+ # is possible
+ if size[0] != size[1]:
+ raise RuntimeError("Only square matrices are allowed for multiplication.")
+
+ # Perform the matrix multiplication of the provided matrices using the Eigen library
+ # Casting is needed due to interface with Eigen library... Not the desired approach,
+ # but works. Ideally, vector should be passed directly, but errors appear
+ mat_1 = np.array(matrix_list[0], dtype=dtype)
+ mat_2 = np.array(matrix_list[1], dtype=dtype)
+ result = demo_eigen_wrapper.multiply_matrices(mat_1, mat_2)
+
+ # Finally, send the response
+ return self._send_matrices(context, result)
+
+
+ # =================================================================================================
+ # PRIVATE METHODS for Server operations
+ # =================================================================================================
+
+ def _get_vectors(self, request_iterator, md: dict):
+ """Process a stream of vector messages.
+
+ Parameters
+ ----------
+ request_iterator : iterator
+ Iterator to the received request messages of type Vector.
+ md : dict
+ Metadata provided by the client.
+
+ Returns
+ -------
+ np.type, tuple, list of np.array
+ Type of data, size of the vectors, and list of vectors to process.
+ """
+ # First, determine how many full vector messages are to be processed
+ full_msgs = int(md.get("full-vectors"))
+
+ # Initialize the output vector list and some aux vars
+ vector_list = []
+ dtype = None
+ size = None
+
+ # Loop over the expected full messages
+ for msg in range(1, full_msgs + 1):
+
+ # Find out how many partial vector messages constitute this full vector message
+ chunks = int(md.get("vec%d-messages" % msg))
+
+ # Initialize the output vector
+ vector = None
+
+ # Loop over the expected chunks
+ for chunk_msg in range(chunks):
+ # Read the vector message
+ chunk_vec = next(request_iterator)
+
+ # Inform about the size of the message content
+ click.echo(
+ "Size of message: "
+ + constants.human_size(chunk_vec.vector_as_chunk)
+ )
+
+ # If processing the first chunk of the message, fill in some data
+ if chunk_msg == 0:
+ # Check the data type of the incoming vector
+ if chunk_vec.data_type == grpcdemo_pb2.DataType.Value("INTEGER"):
+ dtype = check_data_type(dtype, np.int32)
+ elif chunk_vec.data_type == grpcdemo_pb2.DataType.Value("DOUBLE"):
+ dtype = check_data_type(dtype, np.float64)
+
+ # Check the size of the incoming vector
+ size = check_size(size, (chunk_vec.vector_size,))
+
+ # Parse the chunk
+ if vector is None:
+ vector = np.frombuffer(chunk_vec.vector_as_chunk, dtype=dtype)
+ else:
+ tmp = np.frombuffer(chunk_vec.vector_as_chunk, dtype=dtype)
+ vector = np.concatenate((vector, tmp))
+
+ # Check if the final vector has the desired size
+ if vector.size != size[0]:
+ raise RuntimeError("Problems reading client full vector message...")
+ else:
+ # If everything is fine, append to vector_list
+ vector_list.append(vector)
+
+ # Return the input vector list (as a list of numpy.ndarray)
+ return dtype, size, vector_list
+
+ def _get_matrices(self, request_iterator, md: dict):
+ """Process a stream of matrix messages.
+
+ Parameters
+ ----------
+ request_iterator : iterator
+ Iterator to the received request messages of type ``Matrix``.
+ md : dict
+ Metadata provided by the client.
+
+ Returns
+ -------
+ np.type, tuple, list of np.array
+ Type of data, shape of the matrices, and list of matrices to process.
+ """
+ # Determine how many full matrix messages are to be processed
+ full_msgs = int(md.get("full-matrices"))
+
+ # Initialize the output matrix list and some aux vars
+ matrix_list = []
+ dtype = None
+ size = None
+
+ # Loop over the expected full messages
+ for msg in range(1, full_msgs + 1):
+
+ # Find out how many partial matrix messages constitute this full matrix message
+ chunks = int(md.get("mat%d-messages" % msg))
+
+ # Initialize the output matrix
+ matrix = None
+
+ # Loop over the expected chunks
+ for chunk_msg in range(chunks):
+ # Read the matrix message
+ chunk_mat = next(request_iterator)
+
+ # Inform about the size of the message content
+ click.echo(
+ "Size of message: "
+ + constants.human_size(chunk_mat.matrix_as_chunk)
+ )
+
+ # If processing the first chunk of the message, fill in some data
+ if chunk_msg == 0:
+ # Check the data type of the incoming matrix
+ if chunk_mat.data_type == grpcdemo_pb2.DataType.Value("INTEGER"):
+ dtype = check_data_type(dtype, np.int32)
+ elif chunk_mat.data_type == grpcdemo_pb2.DataType.Value("DOUBLE"):
+ dtype = check_data_type(dtype, np.float64)
+
+ # Check the size of the incoming matrix
+ size = check_size(
+ size,
+ (
+ chunk_mat.matrix_rows,
+ chunk_mat.matrix_cols,
+ ),
+ )
+
+ # Parse the chunk
+ if matrix is None:
+ matrix = np.frombuffer(chunk_mat.matrix_as_chunk, dtype=dtype)
+ else:
+ tmp = np.frombuffer(chunk_mat.matrix_as_chunk, dtype=dtype)
+ matrix = np.concatenate((matrix, tmp))
+
+ # Check if the final matrix has the desired size
+ if matrix.size != size[0] * size[1]:
+ raise RuntimeError("Problems reading client full Matrix message...")
+ else:
+ # If everything is fine, append to matrix_list
+ matrix = np.reshape(matrix, size)
+ matrix_list.append(matrix)
+
+ # Return the input matrix list (as a list of numpy.ndarray)
+ return dtype, size, matrix_list
+
+ def _read_client_metadata(self, context):
+ """Return the metadata as a dictionary.
+
+ Parameters
+ ----------
+ context : grpc.ServicerContext
+ gRPC-specific information.
+
+ Returns
+ -------
+ dict
+ Python-readable metadata in dictionary form.
+ """
+ metadata = context.invocation_metadata()
+ metadata_dict = {}
+ for c in metadata:
+ metadata_dict[c.key] = c.value
+
+ return metadata_dict
+
+ def _generate_md(self, message_type: str, abbrev: str, *args: np.ndarray):
+ """Generate the server metadata sent to the client and determine the number of chunks in which to decompose each message.
+
+ Parameters
+ ----------
+ message_type : str
+ Type of message being sent. Options are``vectors`` and ``matrices``.
+ abbrev : str
+ Abbreviated form of the message being sent. Options are ``vec`` and ``mat``.
+
+ Returns
+ -------
+ list[tuple], list[list[int]]
+ Metadata to be sent by the server and the chunk indices for the list
+ of messages to send.
+
+ Raises
+ ------
+ RuntimeError
+ In case of an invalid use of this function.
+ """
+ # Initialize the metadata and the chunks list for each full message
+ md = []
+ chunks = []
+
+ # Find how many arguments are to be transmitted
+ md.append(("full-" + message_type, str(len(args))))
+
+ # Loop over all input arguments
+ idx = 1
+ for arg in args:
+ # Check the size of the arrays
+ # If size is surpassed, determine chunks needed
+ if arg.nbytes > constants.MAX_CHUNKSIZE:
+ # Let us determine how many chunks we will need
+ #
+ # Max amount of elements per chunk
+ max_elems = constants.MAX_CHUNKSIZE // arg.itemsize
+
+ # Bulk number of chunks needed
+ bulk_chunks = arg.size // max_elems
+
+ # The remainder amount of elements (if any)
+ remainder = arg.size % max_elems
+
+ # This list provides the last index up to which to
+ # process in each partial vector or matrix message
+ last_idx_chunk = []
+ for i in range(1, bulk_chunks + 1):
+ last_idx_chunk.append(i * max_elems)
+
+ # Take into account that if there is a remainder,
+ # include one last partial vector or matrix message.
+ if remainder != 0:
+ last_idx_chunk.append(arg.size)
+
+ # Append the results
+ md.append((abbrev + str(idx) + "-messages", str(len(last_idx_chunk))))
+ chunks.append(last_idx_chunk)
+
+ else:
+ # Otherwise dealing with a single message.. Append results.
+ md.append((abbrev + str(idx) + "-messages", str(1)))
+ chunks.append([arg.size])
+
+ # Increase idx by 1
+ idx += 1
+
+ # Return the metadata and the chunks list for each vector or matrix
+ return md, chunks
+
+ def _send_vectors(self, context: grpc.ServicerContext, *args: np.ndarray):
+ """Send the response vector messages.
+
+ Parameters
+ ----------
+ context : grpc.ServicerContext
+ gRPC context.
+ args : np.ndarray
+ Variable size of np.arrays to transmit.
+
+ Yields
+ ------
+ grpcdemo_pb2.Vector
+ Vector messages streamed (full or partial, depending on the metadata)
+ """
+
+ # Generate the metadata and info on the chunks
+ md, chunks = self._generate_md("vectors", "vec", *args)
+
+ # Send the initial metadata
+ context.send_initial_metadata(md)
+
+ # Loop over all input arguments
+ for arg, vector_chunks in zip(args, chunks):
+ # Loop over the chunk indices
+ processed_idx = 0
+ for last_idx_chunk in vector_chunks:
+ # Use tmp_idx in yield function and update the processed_idx afterwards
+ tmp_idx = processed_idx
+ processed_idx = last_idx_chunk
+
+ # Yield!
+ yield grpcdemo_pb2.Vector(
+ data_type=constants.NP_DTYPE_TO_DATATYPE[arg.dtype.type],
+ vector_size=arg.shape[0],
+ vector_as_chunk=arg[tmp_idx:last_idx_chunk].tobytes(),
+ )
+
+ def _send_matrices(self, context: grpc.ServicerContext, *args: np.ndarray):
+ """Sending the response matrix messages.
+
+ Parameters
+ ----------
+ context : grpc.ServicerContext
+ gRPC context.
+ args : np.ndarray
+ Variable size of np.arrays to transmit.
+
+ Yields
+ ------
+ grpcdemo_pb2.Matrix
+ Matrix messages streamed (full or partial, depending on the metadata)
+ """
+
+ # Generate the metadata and info on the chunks
+ md, chunks = self._generate_md("matrices", "mat", *args)
+
+ # Send the initial metadata
+ context.send_initial_metadata(md)
+
+ # Loop over all input arguments
+ for arg, matrix_chunks in zip(args, chunks):
+ # Since we are dealing with matrices, ravel it to a 1D array (avoids copy)
+ arg_as_vec = arg.ravel()
+
+ # Loop over the chunk indices
+ processed_idx = 0
+ for last_idx_chunk in matrix_chunks:
+ # Use tmp_idx in yield function and update the processed_idx afterwards
+ tmp_idx = processed_idx
+ processed_idx = last_idx_chunk
+
+ # Yield!
+ yield grpcdemo_pb2.Matrix(
+ data_type=constants.NP_DTYPE_TO_DATATYPE[arg.dtype.type],
+ matrix_rows=arg.shape[0],
+ matrix_cols=arg.shape[1],
+ matrix_as_chunk=arg_as_vec[tmp_idx:last_idx_chunk].tobytes(),
+ )
+
+
+
+# =================================================================================================
+# SERVING METHODS for Server operations
+# =================================================================================================
+
+
+
+[docs]
+def serve():
+ """Deploy the API Eigen Example server."""
+ server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
+ grpcdemo_pb2_grpc.add_GRPCDemoServicer_to_server(GRPCDemoServicer(), server)
+ server.add_insecure_port("[::]:50051")
+ server.start()
+ server.wait_for_termination()
+
+
+
+if __name__ == "__main__":
+ logging.basicConfig()
+ serve()
+
+
+
+
+
+"""Python implementation of the REST API Eigen example client."""
+
+import json
+
+import numpy as np
+import requests
+
+_EXP_DTYPE = np.dtype("float64")
+"""Expected dtype for numpy arrays."""
+
+
+
+[docs]
+class DemoRESTClient:
+ """Acts as a client to the service provided by the API REST server of this same project.
+ This class has several public methods that allow for direct interaction with the server,
+ without having to care about the formatting of the RESTful queries.
+ """
+
+ # =================================================================================================
+ # PUBLIC METHODS for Client operations
+ # =================================================================================================
+
+ def __init__(self, host, port, user=None, pwd=None, client=None):
+ """Initialize the client.
+
+ Parameters
+ ----------
+ host : str
+ Host (IP/DNS) where the destination server is located.
+ port : int
+ Port that is exposed by the destination server.
+ user : str, optional
+ Username to use in basic authentication. The default is ``None``.
+ pwd : str, optional
+ Password to use in basic authentication. The default is ``None``.
+ client : FlaskClient
+ Flask client, which is to be used only for testing purposes. The default is ``None``.
+ """
+ self._host = host
+ self._port = port
+ self._user = user
+ self._pwd = pwd
+
+ # Depending if we are testing or not... it may be needed to pass the
+ # FlaskClient directly...
+ if client is not None:
+ self._use_test_client = True
+ self._client = client
+ else:
+ self._use_test_client = False
+
+
+[docs]
+ def get_connection_details(self):
+ """Get a simple summary of the connection details."""
+
+ # Check that we are not using a test client
+ if self._use_test_client:
+ print("Using a test client. Unnecessary info.")
+ return
+
+ # First, print the basic details of the connection
+ print(
+ "Connection to host "
+ + self._host
+ + " through port "
+ + str(self._port)
+ + " for using the demo-eigen-wrapper package as a REST Service."
+ )
+
+ # Add, as well, credential details if available
+ if self._user is not None:
+ print(">>> User: " + self._user)
+
+ if self._pwd is not None:
+ print(">>> Pwd: " + self._pwd)
+
+
+
+[docs]
+ def add(self, arg1, arg2):
+ """Add two numpy.ndarrays using the Eigen library (C++), which is exposed via the destination RESTful server.
+
+ Parameters
+ ----------
+ arg1 : numpy.ndarray
+ First numpy.ndarray to consider in the operation.
+ arg2 : numpy.ndarray
+ Second numpy.ndarray to consider in the operation.
+
+ Returns
+ -------
+ numpy.ndarray
+ Sum of adding arg1 and arg2 (arg1 + arg2).
+ """
+ # Check that the provided arguments are inline with the handled parameters by our service
+ arg_dim = self.__check_args(arg1, arg2)
+
+ # Perform the server-related operations
+ return self.__perform_operation(arg1, arg2, arg_dim, "add")
+
+
+
+[docs]
+ def subtract(self, arg1, arg2):
+ """Subtract two numpy.ndarrays using the Eigen library
+ (C++), which is exposed via the destination RESTful server.
+
+ Parameters
+ ----------
+ arg1 : numpy.ndarray
+ First numpy.ndarray to consider in the operation.
+ arg2 : numpy.ndarray
+ Second numpy.ndarray to consider in the operation.
+
+ Returns
+ -------
+ numpy.ndarray
+ The result of subtracting arg2 from arg1 (arg1 - arg2).
+ """
+ # Check that the provided arguments are inline with the handled parameters by our service
+ arg_dim = self.__check_args(arg1, arg2)
+
+ # This operation is not even required to be implemented in the server side...
+ # Just negate arg2... and perform the server-related operations. Pretty easy!
+ return self.__perform_operation(arg1, np.negative(arg2), arg_dim, "add")
+
+
+
+[docs]
+ def multiply(self, arg1, arg2):
+ """Multiply two numpy.ndarrays using the Eigen library (C++), which is exposed via the destination RESTful server.
+
+ Parameters
+ ----------
+ arg1 : numpy.ndarray
+ First numpy.ndarray to consider in the operation.
+ arg2 : numpy.ndarray
+ Second numpy.ndarray to consider in the operation.
+
+ Returns
+ -------
+ numpy.ndarray
+ The result of multiplyng arg1 and arg2 (arg1 * arg2).
+ """
+ # Check that the provided arguments are inline with the handled parameters by our service
+ arg_dim = self.__check_args(arg1, arg2)
+
+ # Perform the server-related operations
+ return self.__perform_operation(arg1, arg2, arg_dim, "multiply")
+
+
+ # =================================================================================================
+ # PRIVATE METHODS for Client operations
+ # =================================================================================================
+
+ def __check_args(self, arg1, arg2):
+ """Check that provided arguments respect the expected inputs by the server. The goal of this
+ private method is to avoid destination server error-throw whenever possible.
+
+ Parameters
+ ----------
+ arg1 : numpy.ndarray
+ First numpy.ndarray to consider in the operation.
+ arg2 : numpy.ndarray
+ Second numpy.ndarray to consider in the operation.
+
+ Returns
+ -------
+ int
+ Shape of the involved numpy.ndarrays.
+
+ Raises
+ ------
+ RuntimeError
+ If the first argument (arg1) is not a numpy.ndarray of type numpy.float64.
+ RuntimeError
+ If the second argument (arg1) is not a numpy.ndarray of type numpy.float64.
+ RuntimeError
+ If the arguments have different shapes.
+ RuntimeError
+ If the dimensions of the arguments are not handled by the destination server.
+ """
+ # Ensure that both arg1 and arg2 are np.ndarrays
+ if (isinstance(arg1, np.ndarray) is not True) or (arg1.dtype is not _EXP_DTYPE):
+ raise RuntimeError(
+ "First argument is not a numpy.ndarray of dtype numpy.float64. Check inputs."
+ )
+ if (isinstance(arg2, np.ndarray) is not True) or (arg2.dtype is not _EXP_DTYPE):
+ raise RuntimeError(
+ "Second argument is not a numpy.ndarray of dtype numpy.float64. Check inputs."
+ )
+
+ # Check as well that both numpy.ndarrays are of the same shape
+ if arg1.shape == arg2.shape:
+ arg_dim = len(arg1.shape)
+ else:
+ raise RuntimeError("Arguments have different shapes. Check inputs.")
+
+ # Return the dimension of the arguments (if it is of the handled types)
+ if arg_dim in (1, 2):
+ return arg_dim
+ else:
+ raise RuntimeError(
+ "Only numpy.ndarrays of 1D (i.e. vectors) or 2D (i.e. matrices) are allowed. Check inputs."
+ )
+
+ def __perform_operation(self, arg1, arg2, arg_dim, ops):
+ """Generalistic private method to handle operations with resources Vectors and Matrices of
+ the destination server.
+
+ Parameters
+ ----------
+ arg1 : numpy.ndarray
+ First numpy.ndarray to consider in the operation.
+ arg2 : numpy.ndarray
+ Second numpy.ndarray to consider in the operation.
+ arg_dim : int
+ Shape of the involved numpy.ndarrays.
+ ops : str
+ Type of operation to carry out. For example, "add" or "multiply".
+
+ Returns
+ -------
+ numpy.ndarray
+ Tesult of the operation requested between arg1 and arg2.
+ """
+ # At this point we must check if we are dealing with a vector or a matrix...
+ # and proceed to perform the requested operation
+ if arg_dim == 1:
+ id1 = self.__post_resource(arg1, "Vectors")
+ id2 = self.__post_resource(arg2, "Vectors")
+ return self.__get_ops_resource(id1, id2, ops, "Vectors")
+ else:
+ id1 = self.__post_resource(arg1, "Matrices")
+ id2 = self.__post_resource(arg2, "Matrices")
+ return self.__get_ops_resource(id1, id2, ops, "Matrices")
+
+ def __post_resource(self, arg, resource):
+ """Generalistic private method to handle the posting of objects to the destination server.
+
+ Parameters
+ ----------
+ arg : numpy.ndarray
+ The numpy.ndarray to post to the destination server.
+ resource : str
+ Type of resource where the posting is to be performed.
+
+ Returns
+ -------
+ int
+ ID of the posted object.
+
+ Raises
+ ------
+ RuntimeError
+ If the Client failed to connect to the destination server.
+ RuntimeError
+ If the Client failed to post the argument to the destination server.
+ """
+ # Perform the post request
+ try:
+ if not self._use_test_client:
+ response = requests.post(
+ self._host + ":" + str(self._port) + "/" + resource,
+ json={"value": arg.tolist()},
+ auth=(self._user, self._pwd),
+ )
+ else:
+ response = self._client.post(
+ "/" + resource,
+ json={"value": arg.tolist()},
+ auth=(self._user, self._pwd),
+ )
+ except (requests.exceptions.ConnectionError):
+ raise RuntimeError(
+ "Could not connect to server... Check server status or connection details."
+ )
+
+ # Check that the status of the response is correct
+ if response.status_code != 201:
+ raise RuntimeError("Client failed to post object in destination Server...")
+
+ # If everything went well... extract the id of the posted object
+ return self.__get_val(json.loads(response.text), "id")
+
+ def __get_ops_resource(self, id1, id2, ops, resource):
+ """_summary_
+
+ Parameters
+ ----------
+ id1 : int
+ ID (in the destination server) of the first argument in the operation.
+ id2 : int
+ ID (in the destination server) of the second argument in the operation.
+ ops : str
+ Type of operation to perform.
+ resource : str
+ Type of resource involved in the operation.
+
+ Returns
+ -------
+ numpy.ndarray
+ Result of the operation requested.
+
+ Raises
+ ------
+ RuntimeError
+ If the Client failed to connect to the destination server.
+ RuntimeError
+ If the Client failed to perform the operation in the destination server.
+ """
+ # Perform the get request
+ try:
+ if not self._use_test_client:
+ response = requests.get(
+ self._host + ":" + str(self._port) + "/" + ops + "/" + resource,
+ json={"id1": id1, "id2": id2},
+ auth=(self._user, self._pwd),
+ )
+ else:
+ response = self._client.get(
+ "/" + ops + "/" + resource,
+ json={"id1": id1, "id2": id2},
+ auth=(self._user, self._pwd),
+ )
+ except (requests.exceptions.ConnectionError):
+ raise RuntimeError(
+ "Could not connect to server... Check server status or connection details."
+ )
+
+ # Check that the status of the response is correct
+ if response.status_code != 200:
+ raise RuntimeError(
+ "Client failed to perform operation in destination Server..."
+ )
+
+ # If everything went well... extract the result of the operation
+ result_aslist = self.__get_val(json.loads(response.text), "result")
+
+ # From the JSON response, when parsed, the result will be considered as a simple
+ # Python object (double, list of doubles...). Convert it to a numpy.ndarray object
+ return np.array(result_aslist, dtype=np.float64)
+
+ def __get_val(self, search_dict, key):
+ """Private method to iterate recursively inside a multidict.
+
+ This method has been gratefully used from https://stackoverflow.com/a/66668504
+
+ Parameters
+ ----------
+ search_dict : dict
+ Dictionary or multiple dictionaries to search.
+ key : str
+ Key to search for.
+
+ Returns
+ -------
+ Any
+ Value of interest.
+ """
+ for elem in search_dict:
+ if elem == key:
+ return search_dict[elem]
+ if isinstance(search_dict[elem], dict):
+ retval = self.__get_val(search_dict[elem], key)
+ if retval is not None:
+ return retval
+
+
+ 
+
+
+
+"""Python implementation of the REST API Eigen example database."""
+
+import os
+import sqlite3
+
+import click
+from flask import current_app, g
+
+# =================================================================================================
+# PUBLIC METHODS for DB interaction
+# =================================================================================================
+
+
+
+[docs]
+def init_app_db(app):
+ """Initialize a simple database for storing API REST data."""
+ current_app = app
+ current_app.app_context().push()
+
+ # Initialize the new app's DB, deleting any pre-existing data and build it from scracth
+ __init_db()
+
+ # Register this function so that it is called whenever a response is returned by the application
+ current_app.teardown_appcontext(__close_db)
+
+ # Emit a message informing the user
+ click.echo("Our App's DB has been initialized!")
+
+
+
+
+[docs]
+def get_db():
+ """Get the database instance of the Flask app.
+
+ Returns
+ -------
+ Connection
+ Connection to the app's database.
+ """
+ if "db" not in g:
+ # Check if folder exists... otherwise, create it
+ os.makedirs(os.path.dirname(current_app.config["DATABASE"]), exist_ok=True)
+
+ g.db = sqlite3.connect(
+ current_app.config["DATABASE"], detect_types=sqlite3.PARSE_DECLTYPES
+ )
+ g.db.row_factory = sqlite3.Row
+
+ return g.db
+
+
+
+# =================================================================================================
+# PRIVATE METHODS for DB interaction
+# =================================================================================================
+
+
+def __close_db(*args):
+ """Close the database."""
+ db = g.pop("db", None)
+
+ if db is not None:
+ db.close()
+
+
+def __init_db():
+ """Initialize the database."""
+ db = get_db()
+
+ with current_app.open_resource("restdb/schema.sql") as f:
+ db.executescript(f.read().decode("utf8"))
+
+
+
+
+
+"""Python implementation of the REST API Eigen example server."""
+
+import json
+from math import floor
+import os
+
+import click
+import demo_eigen_wrapper
+from flask import Flask, jsonify, request
+import numpy as np
+
+from ansys.eigen.python.rest.restdb.db import get_db, init_app_db
+
+#
+#
+# It is necessary to define the environment variable FLASK_APP pointing to this same file
+#
+# For running the app, just call "flask run"
+#
+#
+
+# It would be ideal that Python had switches implemented...
+# ... specially for these constant parameters
+ALLOWED_TYPES = (
+ "vector",
+ "matrix",
+)
+
+ALLOWED_OPS = (
+ "addition",
+ "multiplication",
+)
+
+HUMAN_SIZES = ["B", "KB", "MB", "GB", "TB"]
+
+
+
+[docs]
+def create_app():
+ """Initialize the REST API server.
+
+ Returns
+ -------
+ Flask
+ Instance of the application.
+
+ Raises
+ ------
+ InvalidUsage
+ In case no JSON-format request body was provided.
+ InvalidUsage
+ In case no 'value' is provided within the request body.
+ InvalidUsage
+ In case the given argument is not a string.
+ InvalidUsage
+ In case the given type is not in the ALLOWED_TYPES tuple.
+ """
+ # Create and configure the app
+ app = Flask(__name__, instance_relative_config=True)
+ app.config.from_mapping(
+ SECRET_KEY="dev",
+ DATABASE=os.path.join(app.instance_path, "app.sqlite"),
+ )
+
+ # Tear down previous database and initialize it
+ init_app_db(app)
+
+ # =================================================================================================
+ # PUBLIC METHODS for Server interaction
+ # =================================================================================================
+
+ @app.route("/Vectors", methods=["POST"])
+ def post_vector():
+ """Handles the app's (service's) behavior when accessing the ``Vectors`` resource.
+
+ Returns
+ -------
+ Response
+ Response object containing the ID of the recently posted vector.
+ """
+ # Perform the POST operation using the general method (to avoid code duplications)
+ response_body = __post_eigen_object("vector")
+
+ # Return a successful response with the ID of the created object
+ return response_body, 201
+
+ @app.route("/add/Vectors", methods=["GET"])
+ def add_vectors():
+ """Handles the app's (service's) behavior when accessing the addition
+ operation for the ``Vectors`` resource.
+
+ Returns
+ -------
+ Response
+ Response object containing the vector operation requested.
+ """
+ # Perform the GET operation using the general method (to avoid code duplications)
+ response_body = __ops_eigen_objects("vector", "addition")
+
+ # Return a successful response with the ID of the created object
+ return response_body, 200
+
+ @app.route("/multiply/Vectors", methods=["GET"])
+ def multiply_vectors():
+ """Handles the app's (service's) behavior when accessing the multiplication
+ operation for the ``Vectors`` resource.
+
+ Returns
+ -------
+ Response
+ Response object containing the vector operation requested.
+ """
+ # Perform the GET operation using the general method (to avoid code duplications)
+ response_body = __ops_eigen_objects("vector", "multiplication")
+
+ # Return a successful response with the ID of the created object
+ return response_body, 200
+
+ @app.route("/Matrices", methods=["POST"])
+ def post_matrix():
+ """Handles the app's (service's) behavior when accessing the ``Matrices`` resource
+
+ Returns
+ -------
+ Response
+ Response object containing the ID of the recently posted matrix.
+ """
+ # Perform the POST operation using the general method (to avoid code duplications)
+ response_body = __post_eigen_object("matrix")
+
+ # Return a successful response with the ID of the created object
+ return response_body, 201
+
+ @app.route("/add/Matrices", methods=["GET"])
+ def add_matrices():
+ """Handles the app's (service's) behavior when accessing the addition
+ operation for the ``Matrix`` resource.
+
+ Returns
+ -------
+ Response
+ Response object containing the vector operation requested.
+ """
+ # Perform the GET operation using the general method (to avoid code duplications)
+ response_body = __ops_eigen_objects("matrix", "addition")
+
+ # Return a successful response with the ID of the created object
+ return response_body, 200
+
+ @app.route("/multiply/Matrices", methods=["GET"])
+ def multiply_matrices():
+ """Handles the app's (service's) behavior when accessing the multiplication
+ operation for the ``Matrix`` resource.
+
+ Returns
+ -------
+ Response
+ Response object containing the matrix operation requested.
+ """
+ # Perform the GET operation using the general method (to avoid code duplications)
+ response_body = __ops_eigen_objects("matrix", "multiplication")
+
+ # Return a successful response with the ID of the created object
+ return response_body, 200
+
+ class InvalidUsage(Exception):
+ """Provides the server error class for the API REST server.
+
+ Parameters
+ ----------
+ Exception : class
+ Class from which it inherits.
+
+ Returns
+ -------
+ InvalidUsage
+ Internal server error.
+ """
+
+ status_code = 400
+
+ def __init__(self, message, status_code=None, payload=None):
+ Exception.__init__(self)
+ self.message = message
+ if status_code is not None:
+ self.status_code = status_code
+ self.payload = payload
+
+ def to_dict(self):
+ rv = dict(self.payload or ())
+ rv["message"] = self.message
+ return rv
+
+ @app.errorhandler(InvalidUsage)
+ def handle_invalid_usage(error):
+ """Handles error messages for generating adequate HTTP responses.
+
+ Parameters
+ ----------
+ error : InvalidUsage
+ Incoming error that has been raised.
+
+ Returns
+ -------
+ Response
+ HTTP response with the error information and associated status code.
+ """
+
+ response = jsonify(error.to_dict())
+ response.status_code = error.status_code
+ return response
+
+ # =================================================================================================
+ # PRIVATE METHODS for Server interaction
+ # =================================================================================================
+
+ def __post_eigen_object(type):
+ """Inserts a possible binded object of Eigen (vector or matrix) into the server's database.
+
+ Parameters
+ ----------
+ type : parameter
+ Type of object to insert into the database. It has to be available within the
+ ``ALLOWED_TYPES`` tuple and to be a string.
+
+ Returns
+ -------
+ str
+ JSON-formatted string that contains the ID of the recently inserted object.
+
+ Raises
+ ------
+ InvalidUsage
+ In case no JSON-format request body was provided.
+ InvalidUsage
+ In case no 'value' is provided within the request body.
+ InvalidUsage
+ In case an error was encountered when transforming 'value' into numpy.ndarray.
+ """
+ # Check the argument of this method
+ str_type = __check_value(type, ALLOWED_TYPES)
+
+ # Retrieve the body of the request silently
+ body = request.get_json(silent=True)
+
+ # First check that the request content is in application/json format and
+ # that there are at least some contents within.
+ if body is None:
+ raise InvalidUsage(
+ "No JSON-format (i.e. application/json) body was provided in the request."
+ )
+
+ # Get the object to be inserted into the DB
+ value = body.get("value", None)
+
+ # Check that the object has been indeed provided in the request body
+ if value is None:
+ raise InvalidUsage(
+ "No " + str_type + " has been provided. Expected key: 'value'."
+ )
+
+ # Check that the recently parsed "value" can be transformed into a numpy.ndarray...
+ # Otherwise, throw exception
+ try:
+ np.array(value, dtype=np.float64)
+ except ValueError as error:
+ click.echo(error)
+ raise InvalidUsage(
+ "Error encountered when transforming input string into numpy.ndarray."
+ )
+
+ # Store the value as a string inside the database
+ str_value = json.dumps(value)
+
+ # Insert into DB (as a string) and retrieve the ID of the inserted element
+ db_conn = get_db()
+ cur = db_conn.cursor()
+ cur.execute(
+ "INSERT INTO eigen_db(eigen_type, eigen_value) VALUES (?, ?)",
+ (str_type.upper(), str_value),
+ )
+ db_conn.commit()
+ id_in_db = cur.lastrowid
+
+ # Announce that the object has been added to the DB and..-
+ click.echo(
+ str_type.capitalize()
+ + " with id "
+ + str(id_in_db)
+ + " has been inserted into the server's DB."
+ )
+
+ # Inform about the size of the message content
+ click.echo("Size of message: " + __human_size(request.content_length))
+
+ # ... return the body of the response
+ return json.dumps({str_type: {"id": id_in_db}})
+
+ def __ops_eigen_objects(type, ops):
+ """Handles performing a certain operation on the type of objects provided.
+
+ Parameters
+ ----------
+ type : parameter
+ Type of object to consider in the operation. It has to be available
+ within the ``ALLOWED_TYPES`` tuple and to be a string.
+ ops : parameter
+ Operation to carry out. It has to be available within the ``ALLOWED_OPS``
+ tuple and to be a string.
+
+ Returns
+ -------
+ str
+ JSON-formatted string that contains the result of the operation.
+
+ Raises
+ ------
+ InvalidUsage
+ In case no JSON-format request body was provided.
+ InvalidUsage
+ In case no IDs are provided within the request body.
+ """
+ # Check the arguments of this method
+ str_type = __check_value(type, ALLOWED_TYPES)
+ str_ops = __check_value(ops, ALLOWED_OPS)
+
+ # Retrieve the body of the request silently
+ body = request.get_json(silent=True)
+
+ # Check that the request content is in application/json format and
+ # that there are at least some contents within.
+ if body is None:
+ raise InvalidUsage(
+ "No JSON-format (i.e. application/json) body was provided in the request."
+ )
+
+ # Get the object IDs to be retrieved from the DB
+ id1 = body.get("id1", None)
+ id2 = body.get("id2", None)
+
+ # Check that the object IDs have been provided in the request body
+ if id1 is None or id2 is None:
+ raise InvalidUsage(
+ "Arguments for "
+ + str_ops
+ + " operation with "
+ + str_type
+ + " are not provided. Expected keys: 'id1', 'id2'."
+ )
+
+ # Once the inputs have been verified... perform the operation
+ value = __perform_operation(str_type, str_ops, id1, id2)
+
+ # ... and return the body of the response
+ return json.dumps({str_type + "-" + str_ops: {"result": value}})
+
+ def __check_value(value, allowed_values):
+ """Check to ensure that the provided value is in the ``ALLOWED_*`` tuple
+ and that it is a string.
+
+ Parameters
+ ----------
+ value : parameter
+ Value to process. It has to be available within the ``ALLOWED_*`` tuples
+ provided and has to be a string.
+
+ allowed_values : parameter
+ ``ALLOWED_*`` tuple to consider for evaluation.
+
+ Returns
+ -------
+ str
+ Value argument as a string object.
+
+ Raises
+ ------
+ InvalidUsage
+ In case the given argument is not a string.
+ InvalidUsage
+ In case the given type is not in the ALLOWED_* tuple.
+ """
+ # Check that the provided input is a string
+ if isinstance(value, str) == False:
+ raise InvalidUsage(
+ "The input to __check_value(...) should be a str. Check your implementation."
+ )
+
+ # Work with the "value" arg as a str object
+ str_value = str(value)
+
+ # Check as well that the provided value is one of the allowed values
+ if str_value not in allowed_values:
+ raise InvalidUsage(
+ str_value.capitalize()
+ + " is not one of the allowed values (i.e. ["
+ + ", ".join(allowed_values)
+ + "])."
+ )
+
+ # Return as a str object
+ return str_value
+
+ def __perform_operation(str_type, str_ops, id1, id2):
+ """Retrieve the data from the database DB for performing a certain
+ operation with the eigen-wrapper.
+
+ Parameters
+ ----------
+ str_type : str
+ Type of the objects involved in the operation (vector or matrix).
+ str_ops : str
+ Type of operation to perform. For example, addition or multiplication.
+ id1 : int
+ Dataase identifier for the first object.
+ id2 : int
+ Database identifier for the second object.
+
+ Returns
+ -------
+ double/List(double)
+ Result of the operation.
+ """
+ # Get the values from the DB given the ids (as strings)
+ db_conn = get_db()
+ cur = db_conn.cursor()
+ cur.execute(
+ "SELECT eigen_value FROM eigen_db WHERE id in (?) AND eigen_type in (?)",
+ (id1, str_type.upper()),
+ )
+
+ # Ensure that a value is retrieved for ID1
+ try:
+ str_value1 = cur.fetchone()[0]
+ except TypeError as error:
+ click.echo(error)
+ raise InvalidUsage(
+ "Unexpected error... No values in the database for ID "
+ + str(id1)
+ + " and type "
+ + str_type.capitalize()
+ + "."
+ )
+
+ cur.execute(
+ "SELECT eigen_value FROM eigen_db WHERE id in (?) AND eigen_type in (?)",
+ (id2, str_type.upper()),
+ )
+
+ # Ensure that a value is retrieved for ID2
+ try:
+ str_value2 = cur.fetchone()[0]
+ except TypeError as error:
+ click.echo(error)
+ raise InvalidUsage(
+ "Unexpected error... No values in the database for ID "
+ + str(id2)
+ + " and type "
+ + str_type.capitalize()
+ + "."
+ )
+
+ # Now, convert to np.arrays
+ value1 = np.array(json.loads(str_value1), dtype=np.float64)
+ value2 = np.array(json.loads(str_value2), dtype=np.float64)
+
+ # And finally... perform operation
+ if str_type == "vector" and str_ops == "addition":
+ return demo_eigen_wrapper.add_vectors(value1, value2).tolist()
+ elif str_type == "vector" and str_ops == "multiplication":
+ return demo_eigen_wrapper.multiply_vectors(value1, value2)
+ elif str_type == "matrix" and str_ops == "addition":
+ return demo_eigen_wrapper.add_matrices(value1, value2).tolist()
+ elif str_type == "matrix" and str_ops == "multiplication":
+ return demo_eigen_wrapper.multiply_matrices(value1, value2).tolist()
+ else:
+ # This should not occur
+ return None
+
+ def __human_size(content_length: int):
+ """Show the size of the message in human-readable format.
+
+ Parameters
+ ----------
+ content_length : int
+ Content length of the message.
+
+ Returns
+ -------
+ str
+ Size of the message in human-readable format.
+ """
+ idx = 0
+ while True:
+ if content_length >= 1024:
+ idx += 1
+ content_length = floor(content_length / 1024)
+ else:
+ break
+
+ if idx >= len(HUMAN_SIZES):
+ raise InvalidUsage("Message content above TB level... is not handled.")
+
+ return str(content_length) + HUMAN_SIZES[idx]
+
+ return app
+
+
+
+if __name__ == "__main__":
+ # Create the app
+ app = create_app()
+
+ # When this script is run, deploy the application in 0.0.0.0:5000
+ app.run(host="127.0.0.1", port=5000)
+
+ 
+
+
+Short
+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/_static/copybutton.js b/_static/copybutton.js new file mode 100644 index 00000000..8842ce3c --- /dev/null +++ b/_static/copybutton.js @@ -0,0 +1,248 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copier dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = `` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = `` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for a moment, then changes it back +// We want the timeout of our `success` class to be a bit shorter than the +// tooltip and icon change, so that we can hide the icon before changing back. +var timeoutIcon = 2000; +var timeoutSuccessClass = 1500; + +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + // Remove success a little bit sooner than we change the tooltip + // So that we can use CSS to hide the copybutton first + setTimeout(() => el.classList.remove('success'), timeoutSuccessClass) + setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos'; + + let text = filterText(target, exclude); + return formatCopyText(text, '>>> ?|\\.\\.\\. ', true, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/_static/copybutton_funcs.js b/_static/copybutton_funcs.js new file mode 100644 index 00000000..dbe1aaad --- /dev/null +++ b/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/_static/css/ansys-sphinx-theme-variable.css b/_static/css/ansys-sphinx-theme-variable.css new file mode 100644 index 00000000..04666b28 --- /dev/null +++ b/_static/css/ansys-sphinx-theme-variable.css @@ -0,0 +1,427 @@ +/*Contains variables for colors and fonts used in the theme*/ +@import url("https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap"); + +@font-face { + font-family: "Source Sans Pro Light"; + src: url(../fonts/SourceSansPro-Light.ttf); +} + +@font-face { + font-family: "Source Sans Pro"; + src: url(../fonts/SourceSansPro-Regular.ttf); +} + +:root { + /** Ansys specific changes to the theme */ + + /** + * Ansys Font family + * + * These are adapted from https://systemfontstack.com/ + */ + --pst-font-family-base-system: -apple-system, BlinkMacSystemFont, Segoe UI, + "Helvetica Neue", Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, + Segoe UI Symbol; + --pst-font-family-monospace-system: "SFMono-Regular", Menlo, Consolas, Monaco, + Liberation Mono, Lucida Console, monospace; + + --pst-font-family-base: "Source Sans Pro", sans-serif, + var(--pst-font-family-base-system); + --pst-font-family-heading: "Source Sans Pro", sans-serif, + var(--pst-font-family-base-system); + --pst-font-family-monospace: monospace, Courier, + var(--pst-font-family-monospace-system); + --ast-body-family: "Open Sans", sans-serif; + --ast-header-family: "Source Sans Pro", sans-serif; + + /** + * Ansys compatible colors + * + * Colors are defined in rgb string way, "red, green, blue" + */ + --ansysGold: rgb(255, 183, 27); /* #FFB71B */ + --ansysBronze: rgb(200, 146, 17); /* #C89211 */ + --pythonBlue: rgb(57, 114, 161); /* #3972a1 */ + --pst-font-size-h1: 48px; + --pst-font-size-h2: 40px; + --pst-font-size-h3: 32px; + --pst-font-size-h4: 28px; + --pst-font-size-h5: 24px; + --pst-font-size-h6: 20px; + --ast-global-line-height: 24px; + --bs-nav-link-font-size: 14px; + --bs-navbar-color: var(--bs-ast-navbar-color); + --ast-font-sidebar-header: 16px; + /** +* weight +*/ + --ast-font-weight-regular: 400; + --ast-font-weight-bold: 700; + --ast-font-weight-semibold: 600; + + /** + * table font sizes + */ + --pst-table-font-size: 14px; + --pst-table-header-font-size: 12px; + + --pst-sidebar-font-size-mobile: 12px; + --ast-nav-link-font-size: 14px; + + /** + * sphinx design font sizes + */ + + --ast-sphinx-design-font-size: 14px; + --ast-sphinx-design-font-family: "Open Sans", sans-serif; + --ast-sphinx-design-border-radius: 4px; + + /** +* admonitions +*/ + --ast-admonitions-font-size: 14px; + --ast-admonitions-padding: 8px 16px; + --ast-admonitions-border-radius: 8px; + --ast-admonitions-icon-size: 15px; + --ast-admonition-icon-height: 24px; + --ast-admonition-icon-width: 24px; + --ast-admonition-icon-margin-left: 8px; +} + +html[data-theme="light"] { + /** + * main colors + */ + --ast-color-text: #353535; + --ast-color-active-text: #353535; + --ast-color-hover-text: #353535; + --pst-color-background: #f7f7f7; + --pst-color-primary: #353535; + --pst-color-secondary: #f2f2f2; + --pst-color-success: rgb(40, 167, 69); + --pst-color-text-base: rgb(0, 0, 0); + --pst-color-text-muted: #353535; + --pst-color-border: #686868; + --pst-color-shadow: rgb(216, 216, 216); + --pst-color-info: var(--pst-color-link); + --pst-color-link-hover: #686868; + + /** + * Navigation colors + */ + --pst-color-on-background: var( + --pst-color-background + ); /* important tag from pydata-sphinx-theme */ + --ast-navbar-color: #686868; + --ast-navbar-hover-color: var(--ast-color-hover-text); + --ast-navbar-active-color: var(--ast-color-active-text); + --ast-navbar-active-border-color: #000000; + --ast-ring-shadow-focused: 0px 0px 0px 2px #ffffff, 0px 0px 0px 4px #1a78c2; + + /** + * sidebar colors + */ + --ast-sidebar-primary-text: var(--ast-color-text); + --ast-sidebar-hover-background: #ececec; + --ast-sidebar-active-background: #d9d9d9; + + /** + * depth colors + */ + /* --pst-color-on-background: rgb(0, 0, 0); */ + --pst-color-on-surface: #f2f2f2; + + /** + * table + */ + --ast-color-table-background: #ffffff; + --ast-color-enabled-table-text: var(--ast-color-text); + --ast-color-table-row-hover-bg: #ececec; + --ast-color-table-active-bg: #e9f4fe; + --ast-color-table-header-text: #686868; + --ast-color-table-cell-text: var(--ast-color-text); + --ast-table-outer-border: #ececec; + --ast-color-table-inner-border: #ececec; + + --pst-color-panel-background: var(--pst-color-on-background); + + /** + * layout + */ + + --ast-color-link: #1e6ddc; + --ast-color-link-hover: #1856af; + --ast-color-link-active: #104188; + --ast-color-link-visited: #9a33cb; + --ast-color-link-visited-hover: #7f29a2; + --ast-color-inline-code: var( + --pst-color-text-muted + ); /* inline code color for docutils (_base.scss)*/ + --pst-color-target: rgb(255, 255, 255); + + /** + * color for sphinx-gallery-code output + */ + --pst-color-codecell: #fafae2; + --pst-color-codeout: var(--pst-color-inline-code); + --pst-color-sig: #0965c8; + --pst-color-code-s1: #b35000; + --pst-color-code-c1: #095d0a; + + --ast-sphinx-gallery-download-background: #1a1a1a; + --ast-sphinx-gallery-download-background-hover: #353535; + --ast-sphinx-gallery-download-text: #fdfdfd; + + /** + * sphinx design + */ + --sd-color-primary: var(--pst-color-text-base); + --ast-color-enable-card-background: #ffffff; + --ast-color-enable-border: #d9d9d9; + --ast-color-hover-card-background: #ececec; + --ast-dropdown-border-color: #d9d9d9; + --ast-dropdown-border-color-hover: #8e8e8e; + + --ast-color-sphinx-design-primary: #353535; + --ast-color-sphinx-design-background: #ffffff; + --sd-color-primary: #141414; + --sd-color-primary-highlight: var(--ast-color-sphinx-design-primary); + --sd-color-primary-text: var(--ast-color-sphinx-design-background); + --sd-color-secondary: var(--ast-color-sphinx-design-background); + --sd-color-secondary-text: #141414; + --sd-color-secondary-highlight: var(--ast-color-hover-card-background); + --sd-color-secondary-bg: var(--ast-color-sphinx-design-background); + --ast-sd-bg-secondary-hover: var(--ast-color-hover-card-background); + --ast-background-tab-focus: #d9d9d9; + --ast-background-tab-hover: #ececec; + --ast-tab-border-color: #d9d9d9; + --ast-tab-border-color-hover: #8e8e8e; + --ast-tab-border-color-active: #000000; + --ast-dropdown-text-color: #686868; + --ast-box-shadow-active: 0px 1px 2px 0px rgba(0, 0, 0, 0.08), + 0px 2px 4px 0px rgba(0, 0, 0, 0.12); + --ast-box-shadow-hover: 0px 1px 2px 0px rgba(0, 0, 0, 0.08), + 0px 4px 8px 2px rgba(0, 0, 0, 0.12); + /** + * search hide match + */ + --pst-color-search-match: #91969b; + + /** + * admonitions + */ + --ast-admonition-neutral-icon: #353535; + --ast-admonition-neutral-border: #686868; + --ast-admonition-info-icon: #1a78c2; + --ast-admonition-info-border: #1a78c2; + --ast-admonition-success-icon: #006600; + --ast-admonition-success-border: #008000; + --ast-admonition-warning-icon: #caad2a; + --ast-admonition-warning-border: #fdd835; + --ast-admonition-danger-icon: #b72e2a; + --ast-admonition-danger-border: #e53935; + --ast-admonitions-color: var(--ast-color-text); + + /** + * search bars + */ + --ast-search-bar-enable-background: #ffffff; + --ast-search-bar-enable-border: #d9d9d9; + --ast-search-bar-enable-text: #686868; + --ast-suggestion-header-background: #d9d9d9; + --ast-catagory-header-text: #353535; + --ast-catagory-suggestion-text: #8e8e8e; + --ast-suggestion-text-color: #000000; + --ast-hover-suggestion-text-background: #ececec; + + /** + * dropdown header + */ + --ast-dropdown-header-border: #d9d9d9; +} + +html[data-theme="dark"] { + /** + * main colors + */ + --ast-color-text: #ececec; + --ast-color-active-text: #d5d5d5; + --ast-color-hover-text: #d5d5d5; + --pst-color-primary: #ececec; + --pst-color-secondary: #353535; + --pst-color-success: rgb(72, 135, 87); + --pst-color-text-base: rgb(201, 209, 217); + --pst-color-text-muted: rgb(192, 192, 192); + --pst-color-border: rgb(192, 192, 192); + --pst-color-shadow: rgb(104, 102, 102); + --pst-color-background: #1a1a1a; + --pst-color-surface: rgb(41, 41, 41); + --pst-color-on-surface: rgb(55, 55, 55); + --pst-color-info: var(--pst-color-secondary); + --pst-color-link-hover: #b3b3b3; + + /** + * extensions + */ + + --pst-color-panel-background: var(--pst-color-on-background); + + /** + * Navigation colors + */ + + --pst-color-on-background: var( + --pst-color-background + ); /* important tag from pydata-sphinx-theme */ + --ast-navbar-color: #8e8e8e; + --ast-navbar-hover-color: var(--ast-color-hover-text); + --ast-navbar-active-color: var(--ast-color-active-text); + --ast-navbar-active-border-color: #ffffff; + --ast-nav-link-color: var(--ast-navbar-color); + --ast-ring-shadow-focused: 0px 0px 0px 2px #282828, 0px 0px 0px 4px #4dabf5; + + /** + * sidebar colors + */ + --ast-sidebar-primary-text: var(--ast-color-text); + --ast-sidebar-hover-background: #3d3d3d; + --ast-sidebar-active-background: #2d2d2d; + --ast-color-inline-code: var( + --pst-color-text-muted + ); /* inline code color for docutils (_base.scss)*/ + + /** + * layout + */ + + --ast-color-link: #1e6ddc; + --ast-color-link-hover: #1856af; + --ast-color-link-active: #579ce5; + --ast-color-link-visited: #c58ac5; + --ast-color-link-visited-hover: #a96ba9; + --pst-color-target: rgb(71, 39, 0); + + /** + * color for sphinx-gallery-code output + */ + --pst-color-codecell: #353535; + --pst-color-codeout: #f2f4f6; + --pst-color-sig: #d6ab1e; + --pst-color-code-s1: #d79a60; + --pst-color-code-c1: #8fb842; + + --ast-sphinx-gallery-download-background: #ffffff; + --ast-sphinx-gallery-download-background-hover: #ececec; + --ast-sphinx-gallery-download-text: #1a1a1a; + + /** + * table hovering + */ + --ast-color-table-background: #353535; + --ast-color-enabled-table-text: #ececec; + --ast-color-table-row-hover-bg: #3d3d3d; + --ast-color-table-header-text: #d3d3d3; + --ast-color-table-cell-text: #ececec; + --ast-color-table-active-bg: #3d3d3d; + --ast-table-outer-border: #d3d3d3; + --ast-color-table-inner-border: #d3d3d3; + + /** + * search hide match + */ + --pst-color-search-match: var(--pst-color-primary); + + /** + * sphinx design + */ + + --sd-color-primary: var(--pst-color-text-base); + --ast-color-enable-card-background: #282828; + --ast-color-enable-border: #e5e5e5; + --ast-color-hover-card-background: #3d3d3d; + --ast-dropdown-border-color: #3d3d3d; + --ast-dropdown-border-color-hover: #8e8e8e; + + --ast-color-sphinx-design-primary: #ececec; + --ast-color-sphinx-design-background: #282828; + --sd-color-primary: #d5d5d5; + --sd-color-primary-highlight: var(--ast-color-sphinx-design-primary); + --sd-color-primary-text: var(--ast-color-sphinx-design-background); + --sd-color-secondary: var(--ast-color-sphinx-design-background); + --sd-color-secondary-text: #d5d5d5; + --sd-color-secondary-highlight: var(--ast-color-hover-card-background); + --sd-color-secondary-bg: var(--ast-color-sphinx-design-background); + --ast-sd-bg-secondary-hover: var(--ast-color-hover-card-background); + --ast-background-tab-focus: #2d2d2d; + --ast-background-tab-hover: #3d3d3d; + --ast-tab-border-color: #e5e5e5; + --ast-tab-border-color-hover: #8e8e8e; + --ast-tab-border-color-active: #ffffff; + --ast-dropdown-text-color: #e5e5e5; + --ast-box-shadow-active: 0px 1px 2px 0px rgba(0, 0, 0, 0.4), + 0px 2px 4px 0px rgba(0, 0, 0, 0.48); + --ast-box-shadow-hover: 0px 1px 2px 0px rgba(0, 0, 0, 0.4), + 0px 4px 8px 2px rgba(0, 0, 0, 0.48); + + /** +* admonitions +*/ + --ast-admonition-neutral-icon: #ececec; + --ast-admonition-neutral-border: #8e8e8e; + --ast-admonition-info-icon: #1a78c2; + --ast-admonition-info-border: #1856af; + --ast-admonition-success-icon: #006600; + --ast-admonition-success-border: #147914; + --ast-admonition-warning-icon: #caad2a; + --ast-admonition-warning-border: #bba12e; + --ast-admonition-danger-icon: #b72e2a; + --ast-admonition-danger-border: #b12422; + --ast-admonitions-color: var(--ast-color-text); + + /** + * search bars + */ + --ast-search-bar-enable-background: #2d2d2d; + --ast-search-bar-enable-border: #3d3d3d; + --ast-search-bar-enable-text: #d3d3d3; + --ast-suggestion-header-background: #3d3d3d; + --ast-catagory-header-text: #ececec; + --ast-catagory-suggestion-text: #686868; + --ast-suggestion-text-color: #ffffff; + --ast-hover-suggestion-text-background: #3d3d3d; + + /** + * dropdown header + */ + --ast-dropdown-header-border: #3d3d3d; +} + +/** +* font sizes +* body and content +*/ + +body { + font-family: var(--ast-body-family); + line-height: var(--ast-global-line-height); + font-size: 14px; + color: var(--ast-color-text); +} + +h1, +h2 { + color: var(--pst-color-text-base); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + font-family: var(--ast-header-family); +} + +h1 { + line-height: 56px; +} diff --git a/_static/css/ansys_sphinx_theme.css b/_static/css/ansys_sphinx_theme.css new file mode 100644 index 00000000..6f87ec2a --- /dev/null +++ b/_static/css/ansys_sphinx_theme.css @@ -0,0 +1,45 @@ +/* Provided by the Sphinx base theme template at build time */ + +@import "../basic.css"; +@import "../sg_gallery.css"; +@import "ansys-sphinx-theme-variables.css"; +@import "pydata-sphinx-theme-custom.css"; +@import "breadcrumbs.css"; +@import "ast-search.css"; +@import "sphinx-design.css"; +@import "table-custom.css"; +@import "sphinx-gallery.css"; + +/* +* Code cell +*/ +.xref.std.std-ref { + color: var(--pst-color-inline-code); + font-family: "Inconsolata"; + font-weight: var(--ast-font-weight-regular); + font-style: italic; + padding: 0.1rem 0.25rem; + padding-top: 0.1rem; + padding-right: 0.25rem; + padding-bottom: 0.1rem; + padding-left: 0.25rem; + font-size: 90%; + background-color: var(--pst-color-on-surface); + border: 1px solid var(--pst-color-border); + border-radius: 0.25rem; +} + +/* Reduce empty-space around Notes and Examples headings */ +p.rubric { + margin-top: 0.75em; + margin-bottom: 0.75em; +} + +/* +* Autosummary +*/ + +.autosummary tr:nth-child(odd), +.autosummary tr:nth-child(even) { + background-color: var(--pst-color-background); +} diff --git a/_static/css/ast-search.css b/_static/css/ast-search.css new file mode 100644 index 00000000..130272e3 --- /dev/null +++ b/_static/css/ast-search.css @@ -0,0 +1,154 @@ +@import "ansys-sphinx-theme-variable.css"; + +.static-search-results { + display: flex; + flex-direction: column; + align-content: stretch; + justify-content: flex-start; + position: absolute; + background-color: var(--ast-search-bar-enable-background); + width: 630px; + padding: 1em; + border: 1px solid var(--ast-search-bar-enable-border); + box-shadow: var(--ast-box-shadow-active); + overflow: auto; + max-height: 500px; +} + +.result-item { + cursor: pointer; + transition: box-shadow 0.3s ease; + border-bottom: thin solid var(--ast-search-bar-enable-border); + padding-bottom: 0.5em; + margin-bottom: 0.5em; +} + +.result-item:last-child { + border-bottom: 0; + margin-bottom: 0; +} + +.result-title { + font-size: 1em; + font-weight: var(--ast-font-weight-bold); + font-family: "Open Sans", sans-serif; + color: var(--ast-catagory-header-text); +} + +.result-text { + font-size: 12px; + font-family: "Open Sans", sans-serif; + color: var(--ast-search-bar-enable-text); +} + +.result-item.selected { + box-shadow: var(--ast-ring-shadow-focused); +} + +html[data-theme="light"] .highlight { + color: var(--ast-highlight-color); +} + +.bd-search input.form-control, +.bd-search input.form-control:focus, +.bd-search input.form-control:focus-visible, +.form-control:focus, +.form-control:focus-visible, +.form-control { + background-color: var(--ast-search-bar-enable-background); + color: var(--ast-search-bar-enable-text); + font-size: 14px; + outline-color: var(--ast-search-bar-enable-border); + border: 0px solid var(--ast-search-bar-enable-border); + width: 300px; + transition: max-width 0.3s ease; + max-width: 200%; + height: 40px; +} + +.search-button__wrapper.show input, +.search-button__wrapper.show svg { + font-size: 14px; +} + +.bd-search .search-button__kbd-shortcut { + background-color: var(--ast-search-bar-enable-background) !important; + box-shadow: none !important; + height: 36px; + display: flex; + flex-wrap: wrap; + align-content: center; +} + +.index-select { + color: var(--ast-search-bar-enable-text); + background: var(--ast-search-bar-enable-background); + height: 40px; + font-size: 14px; + font-family: "Open Sans", sans-serif; + border: 0.5px solid var(--ast-search-bar-enable-border); + border-radius: 4px; + box-shadow: none; + padding: 0px 8px; + margin-left: 2px; +} +:focus-visible { + outline: none; +} + +#search-icon { + font-size: 24px; + width: 24px; + height: 24px; + color: var(--ast-search-bar-enable-text); +} + +.form-control:focus, +.bd-search:focus-within { + box-shadow: none; +} + +/* Button Styling */ +.search-button__button { + transition: width 0.3s ease; + width: 50px; /* Initial width */ +} + +/* Result Container Styling */ +.bd-search { + gap: 8px; + background-color: var(--ast-search-bar-enable-background); + border: 0px solid var(--ast-search-bar-enable-border); + margin-bottom: 0px; +} + +.bd-search input.form-control.expanded { + width: 600px; +} + +.search-icon { + cursor: pointer; +} + +.bd-main.blurred { + opacity: 0.5; + transition: opacity 0.3s ease; +} + +@media (max-width: 768px) { + .bd-search input.expanded { + width: 100px; + } + + .form-control { + width: 50px; + } + + .result { + width: 100px; + } + + .bd-search .search-button__kbd-shortcut { + display: none; + } +} diff --git a/_static/css/breadcrumbs.css b/_static/css/breadcrumbs.css new file mode 100644 index 00000000..451add2b --- /dev/null +++ b/_static/css/breadcrumbs.css @@ -0,0 +1,110 @@ +/* Provided by the Sphinx base theme template at build time, +styles exclusively for the ansys-sphinx-theme classes. */ + +@import "ansys-sphinx-theme-variable.css"; + +/** +* Breadcrumbs +*/ + +ul.bd-breadcrumbs li.breadcrumb-item { + padding: 0px; + font-size: 12px; + display: flex; +} + +ul.bd-breadcrumbs li.breadcrumb-item:hover { + text-decoration: underline; + font-size: 12px; +} + +ul.bd-breadcrumbs li.breadcrumb-item a { + color: var(--ast-navbar-color); + font-size: 12px; +} + +ul.bd-breadcrumbs li.breadcrumb-item a:hover { + text-decoration: underline; +} + +ul.bd-breadcrumbs li.breadcrumb-item a:active { + color: var(--ast-color-text); +} + +.breadcrumb-item.active { + color: var(--ast-color-text); +} + +/** +* Version warning announcement +*/ + +#announcement_msg { + display: flex; + justify-content: center; + position: relative; + width: 100%; + padding: 0.5rem 12.5%; + text-align: center; +} + +#announcement_msg :after { + position: absolute; + width: 100%; + height: 100%; + left: 0; + top: 0; + background-color: rgb(223, 95, 114); + opacity: 0.2; + content: ""; + z-index: -1; +} + +#announcement_msg :empty { + display: none; +} + +#announcement_msg p { + font-weight: var(--ast-font-weight-bold); + margin: auto; + color: black; +} + +html[data-theme="dark"] #announcement_msg :after { + background-color: lightpink; + opacity: 0.5; +} + +#announcement_msg a { + color: var(--ast-color-link); +} + +.sidebar-cheatsheets { + text-align: center; +} + +.sidebar-cheatsheets h4 { + font-weight: var(--pst-sidebar-header-font-weight) !important; + font-size: var(--pst-sidebar-header-font-size) !important; + margin-bottom: 0.5rem; +} + +.sidebar-cheatsheets a { + display: inline-flex; + border: 0.5px solid var(--pst-color-border); + padding: 0.25rem; + max-width: 80%; +} + +.sidebar-cheatsheets a:hover { + background-color: var(--pst-color-border); + color: var(--pst-color-text-base); +} + +.sidebar-cheatsheets img { + padding: 0rem; +} + +.bd-sidebar-primary { + padding: 0.5rem; +} diff --git a/_static/css/nbsphinx.css b/_static/css/nbsphinx.css new file mode 100644 index 00000000..685cb1ee --- /dev/null +++ b/_static/css/nbsphinx.css @@ -0,0 +1,10 @@ +/* + * Overrides the default CSS for https://nbsphinx.readthedocs.io/ extension. + */ + +/* + * Do not display the caption paragraph in the body content for 'nbgallery' + */ +.toctree-wrapper > p.caption { + display: none; +} diff --git a/_static/css/pydata-sphinx-theme-custom.css b/_static/css/pydata-sphinx-theme-custom.css new file mode 100644 index 00000000..6f08de28 --- /dev/null +++ b/_static/css/pydata-sphinx-theme-custom.css @@ -0,0 +1,784 @@ +/* Changes associated with the Ansys Sphinx Theme */ +/* for pydata-sphinx-theme */ +@import "../styles/pydata-sphinx-theme.css"; +@import "ansys-sphinx-theme-variable.css"; + +/* +* +* _secondary sidebar and primary sidebars +* _sidebar-primary.scss +* +*/ +.bd-sidebar-primary, +.bd-sidebar-secondary { + max-height: calc(100vh - var(--pst-header-height) - 1vh); + line-height: var(--ast-global-line-height); + border: none; + overflow: auto; +} + +.bd-sidebar-primary .sidebar-primary-items__end { + margin-bottom: unset; + margin-top: unset; +} + +@media (max-width: 959.98px) { + .bd-sidebar-primary { + flex-grow: 0.75; + height: 100vh; + left: 0; + margin-left: -75%; + max-height: 100vh; + max-width: 350px; + position: fixed; + top: 0; + transition: + visibility 0.2s ease-out, + margin 0.2s ease-out; + visibility: hidden; + width: 75%; + z-index: 1055; + } +} + +.sidebar-secondary-item { + border: none; +} + +nav.bd-links p.bd-links__title, +nav.bd-links p.caption { + font-size: var(--ast-font-sidebar-header); + color: var(--ast-sidebar-primary-text); +} + +nav.bd-links li > a { + font-size: var(--ast-font-sidebar-header); + color: var(--ast-sidebar-primary-text); + text-decoration: none; + line-height: var(--ast-global-line-height); + padding: 4px 24px; +} + +nav.bd-links li > a:hover { + color: var(--ast-sidebar-primary-text); + background: var(--ast-sidebar-hover-background); + box-shadow: 1px 1px 2px 0px var(--ast-sidebar-active-background); + border-radius: var(--ast-sphinx-design-border-radius); + text-decoration: none; +} + +nav.bd-links li > a.active, +nav.bd-links li > a.current { + color: var(--ast-color-text); + background: var(--ast-sidebar-active-background); + text-decoration: none; + box-shadow: 1px 1px 2px 0px var(--ast-sidebar-active-background); + border-radius: var(--ast-sphinx-design-border-radius); + font-weight: var(--ast-font-weight-bold); +} + +/** +* sidebar primary with children +*/ + +.bd-sidebar-primary li.has-children .caption, +.bd-sidebar-primary li.has-children > .reference { + padding: 4px 24px; +} + +nav.bd-links .current > a { + color: var(--ast-color-text); + background: var(--ast-sidebar-active-background); + text-decoration: none; + box-shadow: 1px 1px 2px 0px var(--ast-sidebar-active-background); + border-radius: var(--ast-sphinx-design-border-radius); + font-weight: var(--ast-font-weight-bold); +} +/** +* secondary sidebar +* _toc-inpage.scss +*/ +.toc-entry a.nav-link { + color: var(--ast-sidebar-primary-text); + line-height: var(--ast-global-line-height); +} + +.toc-entry a.nav-link.active, +.toc-entry a.nav-link.current { + color: var(--ast-color-link); + text-decoration: none; + box-shadow: none; +} + +.toc-entry a.nav-link.active:hover, +.toc-entry a.nav-link.current:hover { + color: var(--ast-color-link-hover); + text-decoration: none; + box-shadow: none; + font-weight: var(--ast-font-weight-bold); +} + +.toc-h2 { + font-size: var(--pst-table-font-size); + padding: 0.05em; +} + +.toc-h3 { + font-size: var(--pst-table-font-size); +} + +.toc-h4 { + font-size: var(--pst-table-font-size); +} + +.toc-entry a.nav-link:hover { + color: var(--ast-color-link-hover); + text-decoration: none; +} + +/** +* _base.scss related changes +*/ + +.editthispage a { + color: var(--pst-color-text-base); +} + +/** +* +* Dropdown button +* _header.scss +* +*/ + +.bd-header ul.navbar-nav > li.nav-item > .nav-link { + color: var(--ast-navbar-color); + font-weight: var(--ast-font-weight-semibold); +} + +.bd-header ul.navbar-nav > li.nav-item > .nav-link:hover::before { + color: var(--ast-navbar-hover-color); + border-bottom: none; + filter: drop-shadow(0px 1px 2px rgba(0, 0, 0, 0.08)); +} + +.bd-header ul.navbar-nav > li.nav-item > .nav-link:hover { + color: var(--ast-navbar-hover-color); + border-color: var(--ast-navbar-hover-color); + filter: drop-shadow(0px 1px 2px rgba(0, 0, 0, 0.08)); +} + +.bd-header ul.navbar-nav > li.nav-item > .nav-link:active { + color: var(--ast-navbar-active-color); + border-color: var(--ast-navbar-active-border-color); + border-width: 2px; + filter: drop-shadow(0px 1px 2px rgba(0, 0, 0, 0.12)); +} + +.bd-header ul.navbar-nav > li.nav-item.current > .nav-link::before, +.bd-header ul.navbar-nav > li.nav-item.current > .nav-link::after { + color: var(--ast-navbar-active-color); + border-bottom: 2px solid var(--ast-navbar-active-border-color); +} + +.bd-header ul.navbar-nav > li.nav-item > .nav-link:focus-visible { + color: var(--ast-navbar-color); + box-shadow: var(--ast-ring-shadow-focused); + outline: none; + outline-offset: 0px; +} + +html .pst-navbar-icon { + color: var(--ast-navbar-color); +} + +html .pst-navbar-icon:hover { + color: var(--ast-navbar-hover-color); + border-color: var(--ast-navbar-hover-color); + filter: drop-shadow(0px 1px 2px rgba(0, 0, 0, 0.08)); +} + +a.nav-link.pst-navbar-icon { + color: var(--ast-navbar-color); + font-weight: var(--ast-font-weight-bold); +} + +a.nav-link.pst-navbar-icon:hover { + color: var(--ast-navbar-hover-color); + border-color: var(--ast-navbar-hover-color); + filter: drop-shadow(0px 1px 2px rgba(0, 0, 0, 0.08)); + font-weight: var(--ast-font-weight-bold); +} + +a.nav-link.pst-navbar-icon:active { + color: var(--ast-navbar-active-color); + border-color: var(--ast-navbar-active-border-color); + font-weight: var(--ast-font-weight-bold); +} + +ul.navbar-icon-links { + column-gap: 10px; +} + +.bd-header .navbar-header-items__center, +.bd-header .navbar-header-items__end { + column-gap: 10px; +} + +.bd-header .navbar-item { + gap: 8px; +} + +/* +* dropdown button after 5 sections +*/ + +.dropdown-item:hover { + font-weight: var(--ast-font-weight-bold); + background-color: transparent; +} + +/** +* _search.scss +* Search bar +*/ + +.search-button-field { + border-color: var(--ast-navbar-active-border-color); + font-size: var(--ast-nav-link-font-size); + background-color: transparent; + color: var(--ast-navbar-color); +} + +.search-button-field:hover { + border-color: var(--ast-navbar-active-border-color); + color: var(--ast-navbar-hover-color); + font-weight: var(--ast-font-weight-bold); + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.08); +} + +/** +* +* Side column size (first and second column from left) +* +*/ + +.col-md-3 { + flex: 0 0 20%; + max-width: 20%; +} + +a.headerlink { + color: #222; +} + +@media (min-width: 1200px) { + .container, + .container-lg, + .container-md, + .container-sm, + .container-xl { + max-width: 1200px; + } +} + +@media (min-width: 1600px) { + .container, + .container-lg, + .container-md, + .container-sm, + .container-xl { + max-width: 1600px; + } +} + +/** +* +* Navigation column (according to side column) +* _header.scss +* +*/ +.bd-header .navbar-header-items__start { + width: fit-content; + padding-right: 2rem; +} +/** +* header logo +*/ + +.bd-main .bd-content { + display: flex; + height: 100%; + justify-content: end; +} + +.bd-main .bd-content .bd-article-container .bd-article { + padding-left: 1rem; + padding-top: 1rem; + padding-right: 1rem; +} + +/** +* Bold font weight for **code** +*/ + +b, +strong { + font-weight: 900; +} + +/** +* _code.scss related changes +*/ +.docutils { + font-family: var(--pst-font-family-monospace); + font-weight: 500; +} + +#pst-back-to-top { + background: var(--ast-color-link); + color: var(--ast-color-text); +} + +/** +* _api.scss related changes +*/ + +.sig-prename.descclassname { + display: none; +} /* hide the class 'descclassname' for autoapi */ + +.sig { + font-family: var(--pst-font-family-monospace); +} + +.sig-name.descname { + color: var(--pst-color-inline-code); +} + +.sig-name { + color: var(--pst-color-sig); +} + +/** +* highlighted objects inside the api reference +*/ +dt:target, +span.highlighted { + background-color: var(--pst-color-codecell) !important; +} + +/** +* Increase empty-space around classes, methods, properties, etc. that are descendants +* of other items +*/ +dl.class dl.py { + margin-top: 2.5em; + margin-bottom: 2.5em; +} + +/** +* image padding before and after +*/ + +img { + padding-top: 1em; + padding-bottom: 1em; +} + +html[data-theme="dark"] .bd-content img:not(.only-dark):not(.dark-light) { + background: transparent; +} + +img.logo__image { + padding-top: 0rem; + padding-bottom: 0rem; +} + +/** +*Nav-bar entity right side. +*/ + +.list-group-item.active { + z-index: 2; + color: var(--pst-color-text-base) !important; +} + +/** +* admontions +*/ + +div.deprecated { + border-color: var(--pst-color-danger); + background-color: #dc354514; +} + +div.deprecated, +div.versionadded, +div.versionchanged { + background-color: transparent; +} + +.admonition, +div.admonition { + background-color: var(--pst-color-on-surface); +} + +/** +* Select only divisions that contain a dataframe, with enough specificity to override pydata css +*/ +div.nboutput + div.output_area.rendered_html.docutils.container:has(table.dataframe) { + background-color: transparent; +} + +aside.topic > p { + color: var(--pst-color-text-base) !important; +} + +/** +* search hide match +*/ + +div#searchbox p.highlight-link a { + background-color: var(--pst-color-search-match); +} + +.header-article__inner { + padding: 0 1rem; +} + +/** +* +* _links.scss +*/ + +/** +* links on paragraphs +*/ +a { + color: var(--ast-color-link); + text-decoration: none; +} + +a:active { + color: var(--ast-color-link-active); +} + +a:hover, +a:active:hover { + color: var(--ast-color-link-hover); + text-decoration: underline; +} + +a:visited:hover { + color: var(--ast-color-link-visited-hover); +} + +a:visited { + color: var(--ast-color-link-visited); +} + +a:focus-visible { + color: var(--ast-color-link); + box-shadow: var(--ast-ring-shadow-focused); +} + +a > code { + color: var(--ast-color-inline-code); +} + +code.literal { + color: var(--ast-color-inline-code); + font-family: var(--ast-sphinx-design-font-family); +} + +nav.bd-links li > a:focus-visible, +.nav-link:focus-visible, +a.nav-link.pst-navbar-icon:focus-visible, +.toc-entry a.nav-link:focus-visible, +nav.bd-links .current > a:focus-visible { + box-shadow: var(--ast-ring-shadow-focused); + outline: none; +} + +/** +* Admonitions +*/ + +.admonition > .admonition-title, +div.admonition > .admonition-title { + color: var(--ast-admonitions-color); + font-size: var(--ast-admonitions-font-size); + background-color: transparent !important; /* important tag because the admonition has a background color */ + margin-left: 8px; +} + +/** +* Admonitions icons +*/ +.admonition > .admonition-title:after, +div.admonition > .admonition-title:after, +span.versionmodified:before { + font-size: var(--ast-admonitions-icon-size); + height: var(--ast-admonition-icon-height); + width: var(--ast-admonition-icon-width); + left: 0px; + color: var(--ast-color-text); +} + +span.versionmodified:before { + margin-right: 16px; /* separate component, to alligh with title, 8px padding + 8px padding from icon */ +} + +/** +* Admonitions title +*/ + +.admonition p.admonition-title ~ *, +div.admonition p.admonition-title ~ * { + margin-left: 40px; /* separate component, to alligh with title, 8px padding + 24px icon + 8px padding from icon */ + margin-right: 8px; + margin-top: 0px; +} + +.admonition, +div.admonition { + border: 2px solid; + padding: var(--ast-admonitions-padding); + box-shadow: none !important; /* important tag because the admonition has a box-shadow from pydata sphinx theme*/ + border-radius: var(--ast-admonitions-border-radius); +} + +/* warning attention caution important, warning */ + +.admonition.attention > .admonition-title:after, +div.admonition.attention > .admonition-title:after, +.admonition.caution > .admonition-title:after, +div.admonition.caution > .admonition-title:after, +.admonition.important > .admonition-title:after, +div.admonition.important > .admonition-title:after, +.admonition.warning > .admonition-title:after, +div.admonition.warning > .admonition-title:after { + color: var(--ast-admonition-warning-icon); +} + +.admonition.caution, +div.admonition.caution, +.admonition.attention, +div.admonition.attention, +.admonition.important, +div.admonition.important, +.admonition.warning, +div.admonition.warning { + border-color: var(--ast-admonition-warning-border); +} + +/* danger are error, danger, depreciated */ + +.admonition.danger > .admonition-title:after, +div.admonition.danger > .admonition-title:after, +.admonition.error > .admonition-title:after, +div.admonition.error > .admonition-title:after, +span.depreciated.changed:before { + color: var(--ast-admonition-danger-icon); +} + +.admonition.danger, +div.admonition.danger, +.admonition.error, +div.admonition.error, +div.deprecated { + border-color: var(--ast-admonition-danger-border); +} + +/*info are hint, note, see also, tip */ + +.admonition.info > .admonition-title:after, +div.admonition.info > .admonition-title:after, +.admonition.hint > .admonition-title:after, +div.admonition.hint > .admonition-title:after, +.admonition.note > .admonition-title:after, +div.admonition.note > .admonition-title:after, +.admonition.seealso > .admonition-title:after, +div.admonition.seealso > .admonition-title:after, +.admonition.tip > .admonition-title:after, +div.admonition.tip > .admonition-title:after { + color: var(--ast-admonition-info-icon); +} + +.admonition.info, +div.admonition.info, +.admonition.hint, +div.admonition.hint, +.admonition.note, +div.admonition.note, +.admonition.seealso, +div.admonition.seealso, +.admonition.tip, +div.admonition.tip { + border-color: var(--ast-admonition-info-border); +} + +/* success is version-added */ + +span.versionadded.changed:before { + color: var(--ast-admonition-success-icon); +} + +div.versionadded { + border-color: var(--ast-admonition-success-border); +} + +/* neutral is todo, version-change, topic */ + +div.deprecated, +div.versionadded, +div.versionchanged { + border-width: 2px; + border-style: solid; + padding: var(--ast-admonitions-padding); + border-radius: var(--ast-admonitions-border-radius); + box-shadow: none !important; /* important tag because the admonition has a box-shadow from pydata sphinx theme*/ +} + +div.deprecated > p, +div.versionadded > p, +div.versionchanged > p { + margin-left: 8px; +} + +span.versionmodified.changed:before, +.admonition.admonition-todo > .admonition-title:after, +div.admonition.admonition-todo > .admonition-title:after { + color: var(--ast-admonition-neutral-icon); +} + +.admonition.admonition-todo, +div.admonition.admonition-todo, +aside.topic, +div.versionchanged { + border-color: var(--ast-admonition-neutral-border); +} + +aside.topic p, +div.topic p, +div.topic.contents p, +nav.contents p { + color: var(--ast-admonition-neutral-icon) !important; +} +/** +* Dropdown _header.scss +*/ +.bd-header ul.navbar-nav > li.nav-item.dropdown > .dropdown-toggle { + color: var(--ast-navbar-color); + font-weight: var(--ast-font-weight-semibold); + font-size: var(--bs-nav-link-font-size); + border-radius: var(--ast-sphinx-design-border-radius); + border-color: var(--ast-dropdown-header-border); +} + +.bd-header ul.navbar-nav > li.nav-item.dropdown > .dropdown-toggle:hover { + color: var(--ast-navbar-hover-color); + border-bottom: none; + box-shadow: var(--ast-box-shadow-hover); +} + +.bd-header ul.navbar-nav .dropdown .dropdown-menu .dropdown-item { + color: var(--ast-navbar-color); + font-size: var(--bs-nav-link-font-size); + font-weight: var(--ast-font-weight-semibold); + border-radius: var(--ast-sphinx-design-border-radius); + border-color: var(--ast-dropdown-header-border); +} + +/** +* Dropdown _header.scss +*/ + +.version-switcher__menu a.list-group-item { + background-color: var(--ast-color-enable-card-background); + width: 200px; + border: none; + filter: drop-shadow(var(--ast-box-shadow-active)); + color: var(--ast-navbar-hover-color); + font-size: var(--ast-nav-link-font-size); + height: 40px; + padding: 0px 16px; + text-decoration: none; + border-radius: var(--ast-sphinx-design-border-radius); +} + +button.btn.version-switcher__button { + background-color: transparent; + border-color: var(--ast-navbar-active-border-color); + color: var(--ast-navbar-color); + font-size: var(--ast-nav-link-font-size); +} + +button.btn.version-switcher__button:hover { + border-color: var(--ast-navbar-active-border-color); + color: var(--ast-navbar-hover-color); +} + +.version-switcher__menu a.list-group-item:hover { + background-color: var(--ast-color-hover-card-background); + border: none; + color: var(--ast-navbar-hover-color); + font-size: var(--ast-nav-link-font-size); + text-decoration: none; +} + +.version-switcher__menu a.list-group-item:not(:last-child) { + border-bottom: none; +} + +.version-switcher__menu a.list-group-item.active { + box-shadow: none; +} + +.version-switcher__menu { + filter: box-shadow(var(--ast-box-shadow-active)); + border: none; +} + +/** +* Article content (_article.scss) +*/ + +.bd-main .bd-content .bd-article-container { + padding: 8px; + width: 1000px; + max-width: 100%; +} + +@media (min-width: 960px) { + .bd-sidebar-primary { + width: 20%; + } +} + +@media (min-width: 960px) { + .col-lg-3 { + width: fit-content; + } +} + +@media (min-width: 960px) { + .bd-page-width { + max-width: min(100%, 1700px) !important; + } +} + +@media (min-width: 960px) { + .bd-main .bd-content .bd-article-container { + width: min(100%, 1070px); + } +} + +/** +* _math.scss +*/ +span.math { + display: math; +} diff --git a/_static/css/sphinx-design.css b/_static/css/sphinx-design.css new file mode 100644 index 00000000..9582d8b0 --- /dev/null +++ b/_static/css/sphinx-design.css @@ -0,0 +1,247 @@ +@import "../design-style.4045f2051d55cab465a707391d5b2007.min.css"; + +/** +* sphinx design button +*/ + +.sd-btn { + font-size: var(--ast-sphinx-design-font-size); + font-weight: var(--ast-font-weight-regular); + font-family: var(--ast-sphinx-design-font-family); + padding: 8px 16px; + border-radius: var(--ast-sphinx-design-border-radius); +} + +.sd-btn-secondary { + font-size: var(--ast-sphinx-design-font-size); + font-weight: var(--ast-font-weight-regular); + font-family: var(--ast-sphinx-design-font-family); + padding: 8px 16px; + border-radius: var(--ast-sphinx-design-border-radius); + color: var(--sd-color-secondary-text); + background-color: var(--sd-color-secondary); + border-color: var(--sd-color-secondary); +} + +blockquote { + background-color: var(--pst-color-background); +} + +/* Media query for medium-sized screens */ +@media screen and (max-width: 768px) { + .sd-card .sd-card-header { + font-size: var(--pst-font-size-h6); + } +} + +/* Media query for small-sized screens */ +@media screen and (max-width: 576px) { + .sd-card .sd-card-header { + font-size: var(--pst-font-size-h5); + } + .sd-card { + padding: 4px; + } +} +/** +* Sphinx-design dropdown +*/ + +.bd-content details.sd-dropdown:not([open]) > .sd-card-header { + border-radius: var(--ast-sphinx-design-border-radius); +} + +.bd-content details.sd-dropdown { + color: var(--ast-dropdown-text-color); + width: fit-content; + min-width: 400px; +} + +.bd-content details.sd-dropdown summary.sd-summary-title { + font-family: var(--ast-sphinx-design-font-family); + font-size: var(--ast-sphinx-design-font-size); + background: var(--ast-color-sphinx-design-background) !important; + border: 1px solid var(--ast-dropdown-border-color) !important; + border-radius: var(--ast-sphinx-design-border-radius); + padding: 8px 12px; + text-align: left; +} + +.bd-content details.sd-dropdown summary.sd-summary-title:hover { + background-color: var(--ast-color-hover-card-background) !important; + border: 1px solid var(--ast-dropdown-border-color-hover) !important; + border-radius: var(--ast-sphinx-design-border-radius); +} + +.bd-content + details.sd-dropdown + summary.sd-card-header + + div.sd-summary-content { + background-color: var(--ast-color-sphinx-design-background); + border-left: none !important; +} + +.bd-content + details.sd-dropdown + .sd-summary-title:active + + div.sd-summary-content:active { + background-color: var(--ast-color-enable-card-background); + border-color: var(--ast-color-enable-border); +} + +.bd-content + details.sd-dropdown + .sd-summary-title:hover + + div.sd-summary-content:hover { + background-color: var(--ast-color-hover-card-background); + border-color: var(--ast-color-hover-border); + border-left: none; +} + +.bd-content + details.sd-dropdown + summary.sd-summary-title:focus + + div.sd-summary-content:focus { + background-color: var(--ast-color-sphinx-design-background); + border-radius: var(--ast-sphinx-design-border-radius); + border-color: var(--pst-color-border); + border-left: none; +} + +details.sd-dropdown summary.sd-card-header + div.sd-summary-content { + color: var(--ast-color-sphinx-design-primary); + font-family: var(--ast-sphinx-design-font-family); + font-size: var(--ast-sphinx-design-font-size); +} + +/** +* Sphinx-design tab +*/ + +.bd-content .sd-tab-set > label { + font-family: var(--ast-sphinx-design-font-family); + padding: 12px 0px; + border-style: none none solid none; + color: var(--ast-color-sphinx-design-primary); + font-size: var(--ast-sphinx-design-font-size); + margin-inline-end: 16px; + transform: none; + margin-bottom: 1px; +} + +.bd-content .sd-tab-set > input:checked + label:hover, +.bd-content .sd-tab-set > input:not(:checked, :focus-visible) + label:hover { + color: var(--ast-color-sphinx-design-primary); + font-family: var(--ast-sphinx-design-font-family); +} + +.bd-content .sd-tab-set > input + label:focus-visible, +.bd-content + .sd-tab-set + > input:not(:checked, :focus-visible) + + label:focus-visible { + background-color: var(--ast-background-tab-focus); + border-color: transparent transparent var(--ast-tab-border-color-hover) + transparent; + border-width: 0px 0px 2px 0px; + text-decoration-line: none; +} + +.bd-content .sd-tab-set > input:checked + label { + background-color: transparent; + border-color: transparent transparent var(--ast-tab-border-color-active) + transparent; + border-width: 0px 0px 2px 0px; + border-style: none none solid none; + transform: none; +} + +.bd-content .sd-tab-set > input:checked + label:hover { + background-color: var(--ast-background-tab-hover); + border-color: transparent transparent var(--ast-tab-border-color-hover) + transparent; + border-width: 0px 0px 2px 0px; +} + +.bd-content .sd-tab-set > input:not(:checked, :focus-visible) + label { + background-color: transparent; + border-color: transparent transparent var(--ast-tab-border-color) transparent; + border-width: 0px 0px 1px 0px; + text-decoration-line: none; + font-weight: var(--ast-font-weight-regular); +} + +.bd-content .sd-tab-set > input:not(:checked, :focus-visible) + label:hover { + background-color: var(--ast-background-tab-hover); + border-color: transparent transparent var(--ast-tab-border-color-hover) + transparent; + border-width: 0px 0px 2px 0px; + border-style: none none solid none; + text-decoration: none; +} + +.bd-content .sd-tab-set .sd-tab-content { + border: none; + font-family: var(--ast-sphinx-design-font-family); + font-size: var(--ast-sphinx-design-font-size); + color: var(--ast-color-sphinx-design-primary); +} + +/* Media query for medium-sized screens */ +@media screen and (max-width: 768px) { + .sd-tab-set > input:not(.focus-visible) + label { + font-size: 14px; + } +} + +/* Media query for small-sized screens */ +@media screen and (max-width: 576px) { + .sd-tab-set > input:not(.focus-visible) + label { + font-size: 12px; + } +} + +/** +* Sphinx-design card +*/ + +.bd-content .sd-card .sd-card-body, +.bd-content .sd-card .sd-card-footer { + font-size: var(--ast-sphinx-design-font-size); + border: none; + background-color: var(--ast-color-sphinx-design-background); + font-family: var(--ast-sphinx-design-font-family); + color: var(--ast-color-sphinx-design-primary); + border-radius: 8px; +} + +.bd-content .sd-card .sd-card-title, +.bd-content .sd-card .sd-card-header { + font-size: 16px; + border: none; + background-color: var(--ast-color-sphinx-design-background); + font-family: var(--ast-sphinx-design-font-family); + line-height: 24px; +} + +.bd-content .sd-card { + border: none; + border-radius: 8px; + box-shadow: var(--ast-box-shadow-hover) !important; + color: var(--ast-color-sphinx-design-primary); + background-color: var(--ast-color-sphinx-design-background); +} + +.bd-content .sd-card:hover { + box-shadow: var(--ast-box-shadow-hover) !important; +} + +.sd-hide-link-text:focus { + outline: none; + box-shadow: none; +} + +.bd-content .sd-card .sd-stretched-link:focus-visible:after { + outline: none; + box-shadow: var(--ast-ring-shadow-focused); +} diff --git a/_static/css/sphinx-gallery.css b/_static/css/sphinx-gallery.css new file mode 100644 index 00000000..b24541f3 --- /dev/null +++ b/_static/css/sphinx-gallery.css @@ -0,0 +1,66 @@ +@import "ansys-sphinx-theme-variable.css"; + +/** +* Sphinx gallery output cell +*/ + +.highlight pre { + font-size: 0.9em; +} + +/** +* Sphinx gallery download button text +*/ + +a > code.download { + font-family: var(--pst-font-family-base); + color: var(--pst-color-link); + text-decoration: none; + font-weight: var(--ast-font-weight-regular); +} + +div.sphx-glr-download a, +div.sphx-glr-download a:hover { + background-image: none; + color: var(--ast-sphinx-gallery-download-text); + text-decoration: none; + border-radius: 4px; + height: 36px; + padding: 0px 16px; + display: flex; + align-items: flex-start; + justify-content: center; + flex-wrap: wrap; + flex-direction: column; +} +div.sphx-glr-download code.download, +div.sphx-glr-download a.reference.download:before { + color: var(--ast-sphinx-gallery-download-text); +} + +a.reference.download:before { + color: var(--ast-color-text); +} + +div.sphx-glr-download a:hover { + background-color: var(--ast-sphinx-gallery-download-background-hover); +} + +div.sphx-glr-download a { + background-color: var(--ast-sphinx-gallery-download-background); + color: var(--ast-sphinx-gallery-download-text); +} + +div.sphx-glr-footer { + text-align: center; + display: flex; + gap: 10px; + align-content: center; + justify-content: center; + flex-wrap: wrap; + flex-direction: row; +} + +div.sphx-glr-download { + margin: 0px; +} diff --git a/_static/css/table-custom.css b/_static/css/table-custom.css new file mode 100644 index 00000000..5411d1b7 --- /dev/null +++ b/_static/css/table-custom.css @@ -0,0 +1,116 @@ +/** +* Table +* +* the table variables. +*/ + +.table { + --bs-table-bg: var(--ast-color-table-background); + border-spacing: 0; + border-collapse: separate; + overflow: hidden; + vertical-align: middle; + overflow-y: scroll; + scrollbar-width: none; + -ms-overflow-style: none; + border-color: var(--ast-table-outer-border); + background-color: var(--ast-color-table-background); +} + +tbody, +td, +tfoot, +th, +thead, +tr { + border-bottom: 1px solid var(--ast-color-table-inner-border); + background-color: var(--ast-color-table-background); + font-family: var(--ast-font-family-base); + font-size: var(--ast-table-font-size); +} + +.table > :not(caption) > * > * { + padding: 0px 16px; +} + +/** +* Table header +*/ +th { + line-height: 40px; + color: var(--ast-color-table-header-text) !important; + font-size: var(--ast-table-header-font-size) !important; +} + +/** +* Table body +*/ + +tr { + line-height: var(--ast-global-line-height); + height: 56px; + color: var(--ast-color-table-cell-text); +} + +/** +* Table hover +*/ + +tbody :hover, +td :hover, +tfoot :hover, +th :hover, +thead :hover, +tr :hover { + background-color: var(--ast-color-table-row-hover-bg); + font-family: var(--ast-font-family-base); +} + +.table :hover { + background-color: var(--ast-color-table-row-hover-bg); +} + +/** +* Table active +*/ + +.table :active { + background-color: var(--ast-color-table-active-bg); +} +/** +* Table dataframes +*/ + +table.dataframe tr { + font-size: var(--ast-table-font-size); + line-height: 56px; + color: var(--ast-color-table-cell-text); +} + +table.dataframe th { + font-size: var(--ast-table-font-size); + line-height: 40px; + color: var(--ast-color-table-header-text) !important; +} + +table.dataframe :hover { + background-color: var(--ast-color-table-row-hover-bg); + font-family: var(--ast-font-family-base); +} + +table.dataframe :active { + background-color: var(--ast-color-table-active-bg); + font-family: var(--ast-font-family-base); +} + +table.dataframe { + background-color: var(--ast-color-table-background); +} + +.table td ~ td, +.table td ~ th, +.table th ~ td, +.table th ~ th, +.bd-content .nboutput .output_area.rendered_html table.dataframe th ~ td { + border-left: 1px solid var(--ast-color-table-inner-border); +} diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 00000000..0398ebb9 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,149 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 00000000..1f706aa4 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.0.1', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: true, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/fonts/SourceSansPro-Light.ttf b/_static/fonts/SourceSansPro-Light.ttf new file mode 100644 index 00000000..348871ac Binary files /dev/null and b/_static/fonts/SourceSansPro-Light.ttf differ diff --git a/_static/fonts/SourceSansPro-Regular.ttf b/_static/fonts/SourceSansPro-Regular.ttf new file mode 100644 index 00000000..b422bf43 Binary files /dev/null and b/_static/fonts/SourceSansPro-Regular.ttf differ diff --git a/_static/fonts/SourceSansPro-SemiBold.ttf b/_static/fonts/SourceSansPro-SemiBold.ttf new file mode 100644 index 00000000..2908e0d7 Binary files /dev/null and b/_static/fonts/SourceSansPro-SemiBold.ttf differ diff --git a/_static/js/download_target_blank.js b/_static/js/download_target_blank.js new file mode 100644 index 00000000..9f84c70f --- /dev/null +++ b/_static/js/download_target_blank.js @@ -0,0 +1,6 @@ +/* Add target="_blank" attribute to all hyperlinks generated by the ReST :download: directive. + * This will ensure the links open in a new tab. */ + +$(document).ready(function () { + $("a.download").attr("target", "_blank"); +}); diff --git a/_static/js/meilisearch_theme_wrap.js b/_static/js/meilisearch_theme_wrap.js new file mode 100644 index 00000000..8ebc51dd --- /dev/null +++ b/_static/js/meilisearch_theme_wrap.js @@ -0,0 +1,62 @@ +require.config({ + paths: { + docsSearchBar: + "https://cdn.jsdelivr.net/npm/docs-searchbar.js@2.5.0/dist/cdn/docs-searchbar.min", + }, +}); + +require(["docsSearchBar"], function (docsSearchBar) { + document.body.style.overflow = "hidden !important"; + // Initialize the MeiliSearch bar with the given API key and host + var theSearchBar = docsSearchBar({ + hostUrl: HOST_URL, + apiKey: API_KEY, + indexUid: indexUid, + inputSelector: "form.bd-search input", + debug: true, // Set debug to true if you want to inspect the dropdown + meilisearchOptions: { + limit: 10, + }, + }); + + // Function to show the magnifier icon + function showMagnifierIcon() { + var searchIcon = document.getElementById("search-icon"); + searchIcon.classList.remove("fa-spinner", "fa-spin"); // Remove spinner classes + searchIcon.classList.add("fa-magnifying-glass"); // Add magnifier icon class + } + + // Function to show the spinner icon + function showSpinnerIcon() { + var searchIcon = document.getElementById("search-icon"); + if (searchIcon) { + searchIcon.classList.remove("fa-magnifying-glass"); // Remove magnifier icon class + searchIcon.classList.add("fa-spinner", "fa-spin"); // Add spinner classes + } + } + + document + .getElementById("form.bd-search input") + .addEventListener("input", function () { + const inputValue = this.value.trim(); // Trim whitespace from input value + // Show the spinner icon only when there is input and no suggestions + if ( + inputValue && + document.querySelectorAll(".dsb-suggestion").length === 0 + ) { + showSpinnerIcon(); + } else { + // Hide the spinner icon when there are suggestions + showMagnifierIcon(); + } + }); + + // Listen for changes in the dropdown selector and update the index uid and suggestion accordingly + document + .getElementById("indexUidSelector") + .addEventListener("change", function () { + theSearchBar.indexUid = this.value; + theSearchBar.suggestionIndexUid = this.value; + theSearchBar.autocomplete.autocomplete.setVal(""); + }); +}); diff --git a/_static/js/search.js b/_static/js/search.js new file mode 100644 index 00000000..059f253b --- /dev/null +++ b/_static/js/search.js @@ -0,0 +1,269 @@ +const SEARCH_BAR = document.getElementById("search-bar"); +const SEARCH_INPUT = SEARCH_BAR.querySelector(".bd-search input.form-control"); +const RESULTS = document.getElementById("static-search-results"); +const MAIN_PAGE_CONTENT = document.querySelector(".bd-main"); +let CURRENT_INDEX = -1; + +const FUSE_VERSION = "6.4.6"; + +require.config({ + paths: { + fuse: `https://cdn.jsdelivr.net/npm/fuse.js@${FUSE_VERSION}/dist/fuse.min`, + }, +}); + +require(["fuse"], function (Fuse) { + // Declare global variables + let fuse; + + // Debounce function to limit the rate of function calls + function debounce(func, delay) { + let timeout; + return function (...args) { + clearTimeout(timeout); + timeout = setTimeout(() => func.apply(this, args), delay); + }; + } + + // Initialize Fuse when the data is fetched + function initializeFuse(data, options) { + fuse = new Fuse(data, options); + // add env variable "FUSE_ACTIVE" to indicate that the search is ready + document.documentElement.setAttribute("data-fuse_active", "true"); + } + + // Expand the search bar input + function expandSearchInput() { + RESULTS.style.display = "flex"; + SEARCH_INPUT.classList.add("expanded"); + MAIN_PAGE_CONTENT.classList.add("blurred"); + SEARCH_INPUT.focus(); + } + + // Collapse the search bar input and hide any results + function collapseSearchInput() { + RESULTS.style.display = "none"; + SEARCH_INPUT.classList.remove("expanded"); + SEARCH_INPUT.value = ""; + MAIN_PAGE_CONTENT.classList.remove("blurred"); + } + + // Truncate the preview of the text + function truncateTextPreview(text, maxLength = 200) { + if (text.length <= maxLength) { + return text; // If the text is already within the limit, return as is + } + return text.slice(0, maxLength) + "..."; + } + + // Display search results + function displayResults(results) { + if (!RESULTS) { + console.error("RESULTS element is not defined."); + return; + } + + if (results.length === 0) { + noResultsFoundBanner(); + RESULTS.style.display = "none"; + return; + } + + RESULTS.style.display = "flex"; + RESULTS.innerHTML = ""; + + const fragment = document.createDocumentFragment(); + + results.forEach((result) => { + const { title, text, href } = result.item; + + const resultItem = document.createElement("div"); + resultItem.className = "result-item"; + resultItem.dataset.href = href; + resultItem.addEventListener("click", () => navigateToHref(href)); + + const resultTitle = document.createElement("div"); + resultTitle.className = "result-title"; + resultTitle.textContent = title; + resultItem.appendChild(resultTitle); + + const resultText = document.createElement("div"); + resultText.className = "result-text"; + const highlightedText = truncateTextPreview(text); + resultText.textContent = highlightedText; + resultItem.appendChild(resultText); + + fragment.appendChild(resultItem); + }); + + RESULTS.appendChild(fragment); + } + + // Focus the selected result item + function focusSelected(resultsItems) { + if (CURRENT_INDEX >= 0 && CURRENT_INDEX < resultsItems.length) { + resultsItems.forEach((item) => item.classList.remove("selected")); + const currentItem = resultsItems[CURRENT_INDEX]; + currentItem.classList.add("selected"); + currentItem.focus(); + currentItem.scrollIntoView({ block: "nearest" }); + } + } + + // Display a banner indicating that the search is running + function noResultsFoundBanner() { + RESULTS.innerHTML = ""; + RESULTS.style.display = "flex"; + const warningBanner = document.createElement("div"); + warningBanner.className = "warning-banner"; + warningBanner.textContent = + "No results found. Press Enter for extended search."; + warningBanner.style.display = "block"; + warningBanner.style.fontStyle = "italic"; + RESULTS.appendChild(warningBanner); + } + + // Build the complete hyperlink for the target file + function getDynamicPath(targetFile) { + const contentRoot = + document.documentElement.getAttribute("data-content_root"); + return `${contentRoot}${targetFile}`; + } + + // Navigate to the desired file + function navigateToHref(href) { + const finalUrl = getDynamicPath(href); + window.location.href = finalUrl; + } + + // Display a banner indicating that no results were found + function searchingForResultsBanner() { + RESULTS.innerHTML = ""; + RESULTS.style.display = "flex"; + const searchingBanner = document.createElement("div"); + searchingBanner.className = "searching-banner"; + searchingBanner.textContent = "Searching..."; + searchingBanner.style.display = "block"; + console.log("Searching..."); + searchingBanner.style.fontStyle = "italic"; + RESULTS.appendChild(searchingBanner); + } + + // Handle search input + const handleSearchInput = debounce( + () => { + const query = SEARCH_INPUT.value.trim(); + if (query.length > 0) { + const searchResults = fuse.search(query, { + limit: parseInt(SEARCH_OPTIONS.limit), + }); + if (searchResults.length === 0) { + noResultsFoundBanner(); + } else { + displayResults(searchResults); + } + } else { + RESULTS.style.display = "none"; + } + }, + parseInt(SEARCH_OPTIONS.delay) || 300, + ); + + // Handle keydown event for the search input + function handleKeyDownSearchInput(event) { + const resultItems = RESULTS.querySelectorAll(".result-item"); + + switch (event.key) { + case "Tab": + event.preventDefault(); + break; + + case "Escape": + collapseSearchInput(); + break; // Added break to avoid fall-through + + case "Enter": + // Optionally handle Enter key here + if (CURRENT_INDEX >= 0 && CURRENT_INDEX < resultItems.length) { + event.preventDefault(); // Prevent default enter action + const href = resultItems[CURRENT_INDEX].dataset.href; + navigateToHref(href); + } + if (resultItems.length > 0) { + event.preventDefault(); // Prevent default enter action + const href = resultItems[0].dataset.href; + navigateToHref(href); + } + + break; + + case "ArrowDown": + if (resultItems.length > 0) { + CURRENT_INDEX = (CURRENT_INDEX + 1) % resultItems.length; // Move down + focusSelected(resultItems); + } + break; + + case "ArrowUp": + if (resultItems.length > 0) { + CURRENT_INDEX = + (CURRENT_INDEX - 1 + resultItems.length) % resultItems.length; // Move up + focusSelected(resultItems); + } + break; + + default: + // if environment variable "FUSE_ACTIVE" is set to true + if ( + document.documentElement.getAttribute("data-fuse_active") === "true" + ) { + searchingForResultsBanner(); + } else { + console.error("[AST]: Fuse is not active yet."); + RESULTS.style.display = "none"; + } + handleSearchInput(); + } + } + + // Handle keydown event globally + function handleGlobalKeyDown(event) { + switch (event.key) { + case "k": + if (event.ctrlKey) { + expandSearchInput(); + } + break; + + case "Escape": + collapseSearchInput(); + break; + } + } + + // Handle click event globally + function handleGlobalClick(event) { + if (!RESULTS.contains(event.target) && event.target !== SEARCH_INPUT) { + collapseSearchInput(); + } + } + + // Add event listeners + SEARCH_INPUT.addEventListener("click", expandSearchInput); + SEARCH_INPUT.addEventListener("keydown", handleKeyDownSearchInput); + document.addEventListener("keydown", handleGlobalKeyDown); + document.addEventListener("click", handleGlobalClick); + + // Fetch search data and initialize Fuse + fetch(SEARCH_FILE) + .then((response) => { + if (!response.ok) { + throw new Error(`[AST]: HTTPS error ${response.statusText}`); + } + return response.json(); + }) + .then((SEARCH_DATA) => initializeFuse(SEARCH_DATA, SEARCH_OPTIONS)) + .catch((error) => + console.error(`[AST]: Can not fetch ${SEARCH_FILE}`, error.message), + ); +}); diff --git a/_static/js/table.js b/_static/js/table.js new file mode 100644 index 00000000..a080ead1 --- /dev/null +++ b/_static/js/table.js @@ -0,0 +1,3 @@ +$(document).ready(function () { + $("table.datatable").DataTable(); +}); diff --git a/_static/jupyter-sphinx.css b/_static/jupyter-sphinx.css new file mode 100644 index 00000000..87724dfc --- /dev/null +++ b/_static/jupyter-sphinx.css @@ -0,0 +1,123 @@ +/* Stylesheet for jupyter-sphinx + +These styles mimic the Jupyter HTML styles. + +The default CSS (Cascading Style Sheet) class structure of jupyter-sphinx +is the following: + +jupyter_container + code_cell (optional) + stderr (optional) + output (optional) + +If the code_cell is not displayed, then there is not a jupyter_container, and +the output is provided without CSS. + +This stylesheet attempts to override the defaults of all packaged Sphinx themes +to display jupter-sphinx cells in a Jupyter-like style. + +If you want to adjust the styles, add additional custom CSS to override these +styles. + +After a build, this stylesheet is loaded from ./_static/jupyter-sphinx.css . + +*/ + + +div.jupyter_container { + padding: .4em; + margin: 0 0 .4em 0; + background-color: #FFFF; + border: 1px solid #CCC; + -moz-box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2); + -webkit-box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2); + box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2); +} +.jupyter_container div.code_cell { + border: 1px solid #cfcfcf; + border-radius: 2px; + background-color: #f7f7f7; + margin: 0 0; + overflow: auto; +} + +.jupyter_container div.code_cell pre { + padding: 4px; + margin: 0 0; + background-color: #f7f7f7; + border: none; + background: none; + box-shadow: none; + -webkit-box-shadow: none; /* for nature */ + -moz-box-shadow: none; /* for nature */ +} + +.jupyter_container div.code_cell * { + margin: 0 0; +} +div.jupyter_container div.highlight { + background-color: #f7f7f7; /* for haiku */ +} +div.jupyter_container { + padding: 0; + margin: 0; +} + +/* Prevent alabaster breaking highlight alignment */ +div.jupyter_container .hll { + padding: 0; + margin: 0; +} + +/* overrides for sphinx_rtd_theme */ +.rst-content .jupyter_container div[class^='highlight'], +.document .jupyter_container div[class^='highlight'], +.rst-content .jupyter_container pre.literal-block { + border:none; + margin: 0; + padding: 0; + background: none; + padding: 3px; + background-color: transparent; +} +/* restore Mathjax CSS, as it assumes a vertical margin. */ +.jupyter_container .MathJax_Display { + margin: 1em 0em; + text-align: center; +} +.jupyter_container .stderr { + background-color: #FCC; + border: none; + padding: 3px; +} +.jupyter_container .output { + border: none; +} +.jupyter_container div.output pre { + background-color: white; + background: none; + padding: 4px; + border: none; + box-shadow: none; + -webkit-box-shadow: none; /* for nature */ + -moz-box-shadow: none; /* for nature */ +} +.jupyter_container .code_cell td.linenos { + text-align: right; + padding: 4px 4px 4px 8px; + border-right: 1px solid #cfcfcf; + color: #999; +} +.jupyter_container .output .highlight { + background-color: #ffffff; +} +/* combine sequential jupyter cells, + by moving sequential ones up higher on y-axis */ +div.jupyter_container + div.jupyter_container { + margin: -.5em 0 .4em 0; +} + +/* Fix for sphinx_rtd_theme spacing after jupyter_container #91 */ +.rst-content .jupyter_container { + margin: 0 0 24px 0; +} diff --git a/_static/jupyterlite_badge_logo.svg b/_static/jupyterlite_badge_logo.svg new file mode 100644 index 00000000..5de36d7f --- /dev/null +++ b/_static/jupyterlite_badge_logo.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/_static/language_data.js b/_static/language_data.js new file mode 100644 index 00000000..c7fe6c6f --- /dev/null +++ b/_static/language_data.js @@ -0,0 +1,192 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/logos/ansys-favicon.png b/_static/logos/ansys-favicon.png new file mode 100644 index 00000000..cfb2e535 Binary files /dev/null and b/_static/logos/ansys-favicon.png differ diff --git a/_static/logos/ansys_logo_black.jpg b/_static/logos/ansys_logo_black.jpg new file mode 100644 index 00000000..7f737335 Binary files /dev/null and b/_static/logos/ansys_logo_black.jpg differ diff --git a/_static/logos/ansys_logo_black_cropped.jpg b/_static/logos/ansys_logo_black_cropped.jpg new file mode 100644 index 00000000..05d98e6c Binary files /dev/null and b/_static/logos/ansys_logo_black_cropped.jpg differ diff --git a/_static/logos/ansys_logo_transparent_black.png b/_static/logos/ansys_logo_transparent_black.png new file mode 100644 index 00000000..8ce219af Binary files /dev/null and b/_static/logos/ansys_logo_transparent_black.png differ diff --git a/_static/logos/ansys_logo_transparent_white.png b/_static/logos/ansys_logo_transparent_white.png new file mode 100644 index 00000000..6121882b Binary files /dev/null and b/_static/logos/ansys_logo_transparent_white.png differ diff --git a/_static/logos/ansys_logo_white.pdf b/_static/logos/ansys_logo_white.pdf new file mode 100644 index 00000000..fceb89b3 Binary files /dev/null and b/_static/logos/ansys_logo_white.pdf differ diff --git a/_static/logos/ansys_logo_white_cropped.pdf b/_static/logos/ansys_logo_white_cropped.pdf new file mode 100644 index 00000000..ad122b15 Binary files /dev/null and b/_static/logos/ansys_logo_white_cropped.pdf differ diff --git a/_static/logos/pyansys-logo-black-cropped.png b/_static/logos/pyansys-logo-black-cropped.png new file mode 100644 index 00000000..e28bc3de Binary files /dev/null and b/_static/logos/pyansys-logo-black-cropped.png differ diff --git a/_static/logos/pyansys-logo-white-cropped.png b/_static/logos/pyansys-logo-white-cropped.png new file mode 100644 index 00000000..91b50f98 Binary files /dev/null and b/_static/logos/pyansys-logo-white-cropped.png differ diff --git a/_static/logos/pyansys_dark.png b/_static/logos/pyansys_dark.png new file mode 100644 index 00000000..b0ff9e19 Binary files /dev/null and b/_static/logos/pyansys_dark.png differ diff --git a/_static/logos/pyansys_dark_square.png b/_static/logos/pyansys_dark_square.png new file mode 100644 index 00000000..2b271562 Binary files /dev/null and b/_static/logos/pyansys_dark_square.png differ diff --git a/_static/logos/pyansys_light.png b/_static/logos/pyansys_light.png new file mode 100644 index 00000000..9f31babd Binary files /dev/null and b/_static/logos/pyansys_light.png differ diff --git a/_static/logos/pyansys_light_square.png b/_static/logos/pyansys_light_square.png new file mode 100644 index 00000000..3e0706a5 Binary files /dev/null and b/_static/logos/pyansys_light_square.png differ diff --git a/_static/logos/pyansys_logo_transparent_black.png b/_static/logos/pyansys_logo_transparent_black.png new file mode 100644 index 00000000..a20b724c Binary files /dev/null and b/_static/logos/pyansys_logo_transparent_black.png differ diff --git a/_static/logos/pyansys_logo_transparent_white.png b/_static/logos/pyansys_logo_transparent_white.png new file mode 100644 index 00000000..a507ee8e Binary files /dev/null and b/_static/logos/pyansys_logo_transparent_white.png differ diff --git a/_static/logos/watermark.pdf b/_static/logos/watermark.pdf new file mode 100644 index 00000000..202d1e69 Binary files /dev/null and b/_static/logos/watermark.pdf differ diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/no_image.png b/_static/no_image.png new file mode 100644 index 00000000..8c2d48d5 Binary files /dev/null and b/_static/no_image.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 00000000..5bbc1bec --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,160 @@ +html[data-theme="light"] .highlight pre { line-height: 125%; } +html[data-theme="light"] .highlight td.linenos .normal { color: #666666; background-color: transparent; padding-left: 5px; padding-right: 5px; } +html[data-theme="light"] .highlight span.linenos { color: #666666; background-color: transparent; padding-left: 5px; padding-right: 5px; } +html[data-theme="light"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +html[data-theme="light"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +html[data-theme="light"] .highlight .hll { background-color: #ffffcc } +html[data-theme="light"] .highlight { background: #f0f0f0; } +html[data-theme="light"] .highlight .c { color: #60a0b0; font-style: italic } /* Comment */ +html[data-theme="light"] .highlight .err { border: 1px solid #FF0000 } /* Error */ +html[data-theme="light"] .highlight .k { color: #007020; font-weight: bold } /* Keyword */ +html[data-theme="light"] .highlight .o { color: #666666 } /* Operator */ +html[data-theme="light"] .highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */ +html[data-theme="light"] .highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */ +html[data-theme="light"] .highlight .cp { color: #007020 } /* Comment.Preproc */ +html[data-theme="light"] .highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */ +html[data-theme="light"] .highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */ +html[data-theme="light"] .highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */ +html[data-theme="light"] .highlight .gd { color: #A00000 } /* Generic.Deleted */ +html[data-theme="light"] .highlight .ge { font-style: italic } /* Generic.Emph */ +html[data-theme="light"] .highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +html[data-theme="light"] .highlight .gr { color: #FF0000 } /* Generic.Error */ +html[data-theme="light"] .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +html[data-theme="light"] .highlight .gi { color: #00A000 } /* Generic.Inserted */ +html[data-theme="light"] .highlight .go { color: #888888 } /* Generic.Output */ +html[data-theme="light"] .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +html[data-theme="light"] .highlight .gs { font-weight: bold } /* Generic.Strong */ +html[data-theme="light"] .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +html[data-theme="light"] .highlight .gt { color: #0044DD } /* Generic.Traceback */ +html[data-theme="light"] .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +html[data-theme="light"] .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +html[data-theme="light"] .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +html[data-theme="light"] .highlight .kp { color: #007020 } /* Keyword.Pseudo */ +html[data-theme="light"] .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +html[data-theme="light"] .highlight .kt { color: #902000 } /* Keyword.Type */ +html[data-theme="light"] .highlight .m { color: #40a070 } /* Literal.Number */ +html[data-theme="light"] .highlight .s { color: #4070a0 } /* Literal.String */ +html[data-theme="light"] .highlight .na { color: #4070a0 } /* Name.Attribute */ +html[data-theme="light"] .highlight .nb { color: #007020 } /* Name.Builtin */ +html[data-theme="light"] .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +html[data-theme="light"] .highlight .no { color: #60add5 } /* Name.Constant */ +html[data-theme="light"] .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +html[data-theme="light"] .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +html[data-theme="light"] .highlight .ne { color: #007020 } /* Name.Exception */ +html[data-theme="light"] .highlight .nf { color: #06287e } /* Name.Function */ +html[data-theme="light"] .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +html[data-theme="light"] .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +html[data-theme="light"] .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +html[data-theme="light"] .highlight .nv { color: #bb60d5 } /* Name.Variable */ +html[data-theme="light"] .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +html[data-theme="light"] .highlight .w { color: #bbbbbb } /* Text.Whitespace */ +html[data-theme="light"] .highlight .mb { color: #40a070 } /* Literal.Number.Bin */ +html[data-theme="light"] .highlight .mf { color: #40a070 } /* Literal.Number.Float */ +html[data-theme="light"] .highlight .mh { color: #40a070 } /* Literal.Number.Hex */ +html[data-theme="light"] .highlight .mi { color: #40a070 } /* Literal.Number.Integer */ +html[data-theme="light"] .highlight .mo { color: #40a070 } /* Literal.Number.Oct */ +html[data-theme="light"] .highlight .sa { color: #4070a0 } /* Literal.String.Affix */ +html[data-theme="light"] .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +html[data-theme="light"] .highlight .sc { color: #4070a0 } /* Literal.String.Char */ +html[data-theme="light"] .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ +html[data-theme="light"] .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +html[data-theme="light"] .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +html[data-theme="light"] .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +html[data-theme="light"] .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +html[data-theme="light"] .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +html[data-theme="light"] .highlight .sx { color: #c65d09 } /* Literal.String.Other */ +html[data-theme="light"] .highlight .sr { color: #235388 } /* Literal.String.Regex */ +html[data-theme="light"] .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +html[data-theme="light"] .highlight .ss { color: #517918 } /* Literal.String.Symbol */ +html[data-theme="light"] .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +html[data-theme="light"] .highlight .fm { color: #06287e } /* Name.Function.Magic */ +html[data-theme="light"] .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +html[data-theme="light"] .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +html[data-theme="light"] .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +html[data-theme="light"] .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ +html[data-theme="light"] .highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */ +html[data-theme="dark"] .highlight pre { line-height: 125%; } +html[data-theme="dark"] .highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +html[data-theme="dark"] .highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +html[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +html[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +html[data-theme="dark"] .highlight .hll { background-color: #49483e } +html[data-theme="dark"] .highlight { background: #272822; color: #f8f8f2 } +html[data-theme="dark"] .highlight .c { color: #959077 } /* Comment */ +html[data-theme="dark"] .highlight .err { color: #ed007e; background-color: #1e0010 } /* Error */ +html[data-theme="dark"] .highlight .esc { color: #f8f8f2 } /* Escape */ +html[data-theme="dark"] .highlight .g { color: #f8f8f2 } /* Generic */ +html[data-theme="dark"] .highlight .k { color: #66d9ef } /* Keyword */ +html[data-theme="dark"] .highlight .l { color: #ae81ff } /* Literal */ +html[data-theme="dark"] .highlight .n { color: #f8f8f2 } /* Name */ +html[data-theme="dark"] .highlight .o { color: #ff4689 } /* Operator */ +html[data-theme="dark"] .highlight .x { color: #f8f8f2 } /* Other */ +html[data-theme="dark"] .highlight .p { color: #f8f8f2 } /* Punctuation */ +html[data-theme="dark"] .highlight .ch { color: #959077 } /* Comment.Hashbang */ +html[data-theme="dark"] .highlight .cm { color: #959077 } /* Comment.Multiline */ +html[data-theme="dark"] .highlight .cp { color: #959077 } /* Comment.Preproc */ +html[data-theme="dark"] .highlight .cpf { color: #959077 } /* Comment.PreprocFile */ +html[data-theme="dark"] .highlight .c1 { color: #959077 } /* Comment.Single */ +html[data-theme="dark"] .highlight .cs { color: #959077 } /* Comment.Special */ +html[data-theme="dark"] .highlight .gd { color: #ff4689 } /* Generic.Deleted */ +html[data-theme="dark"] .highlight .ge { color: #f8f8f2; font-style: italic } /* Generic.Emph */ +html[data-theme="dark"] .highlight .ges { color: #f8f8f2; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +html[data-theme="dark"] .highlight .gr { color: #f8f8f2 } /* Generic.Error */ +html[data-theme="dark"] .highlight .gh { color: #f8f8f2 } /* Generic.Heading */ +html[data-theme="dark"] .highlight .gi { color: #a6e22e } /* Generic.Inserted */ +html[data-theme="dark"] .highlight .go { color: #66d9ef } /* Generic.Output */ +html[data-theme="dark"] .highlight .gp { color: #ff4689; font-weight: bold } /* Generic.Prompt */ +html[data-theme="dark"] .highlight .gs { color: #f8f8f2; font-weight: bold } /* Generic.Strong */ +html[data-theme="dark"] .highlight .gu { color: #959077 } /* Generic.Subheading */ +html[data-theme="dark"] .highlight .gt { color: #f8f8f2 } /* Generic.Traceback */ +html[data-theme="dark"] .highlight .kc { color: #66d9ef } /* Keyword.Constant */ +html[data-theme="dark"] .highlight .kd { color: #66d9ef } /* Keyword.Declaration */ +html[data-theme="dark"] .highlight .kn { color: #ff4689 } /* Keyword.Namespace */ +html[data-theme="dark"] .highlight .kp { color: #66d9ef } /* Keyword.Pseudo */ +html[data-theme="dark"] .highlight .kr { color: #66d9ef } /* Keyword.Reserved */ +html[data-theme="dark"] .highlight .kt { color: #66d9ef } /* Keyword.Type */ +html[data-theme="dark"] .highlight .ld { color: #e6db74 } /* Literal.Date */ +html[data-theme="dark"] .highlight .m { color: #ae81ff } /* Literal.Number */ +html[data-theme="dark"] .highlight .s { color: #e6db74 } /* Literal.String */ +html[data-theme="dark"] .highlight .na { color: #a6e22e } /* Name.Attribute */ +html[data-theme="dark"] .highlight .nb { color: #f8f8f2 } /* Name.Builtin */ +html[data-theme="dark"] .highlight .nc { color: #a6e22e } /* Name.Class */ +html[data-theme="dark"] .highlight .no { color: #66d9ef } /* Name.Constant */ +html[data-theme="dark"] .highlight .nd { color: #a6e22e } /* Name.Decorator */ +html[data-theme="dark"] .highlight .ni { color: #f8f8f2 } /* Name.Entity */ +html[data-theme="dark"] .highlight .ne { color: #a6e22e } /* Name.Exception */ +html[data-theme="dark"] .highlight .nf { color: #a6e22e } /* Name.Function */ +html[data-theme="dark"] .highlight .nl { color: #f8f8f2 } /* Name.Label */ +html[data-theme="dark"] .highlight .nn { color: #f8f8f2 } /* Name.Namespace */ +html[data-theme="dark"] .highlight .nx { color: #a6e22e } /* Name.Other */ +html[data-theme="dark"] .highlight .py { color: #f8f8f2 } /* Name.Property */ +html[data-theme="dark"] .highlight .nt { color: #ff4689 } /* Name.Tag */ +html[data-theme="dark"] .highlight .nv { color: #f8f8f2 } /* Name.Variable */ +html[data-theme="dark"] .highlight .ow { color: #ff4689 } /* Operator.Word */ +html[data-theme="dark"] .highlight .pm { color: #f8f8f2 } /* Punctuation.Marker */ +html[data-theme="dark"] .highlight .w { color: #f8f8f2 } /* Text.Whitespace */ +html[data-theme="dark"] .highlight .mb { color: #ae81ff } /* Literal.Number.Bin */ +html[data-theme="dark"] .highlight .mf { color: #ae81ff } /* Literal.Number.Float */ +html[data-theme="dark"] .highlight .mh { color: #ae81ff } /* Literal.Number.Hex */ +html[data-theme="dark"] .highlight .mi { color: #ae81ff } /* Literal.Number.Integer */ +html[data-theme="dark"] .highlight .mo { color: #ae81ff } /* Literal.Number.Oct */ +html[data-theme="dark"] .highlight .sa { color: #e6db74 } /* Literal.String.Affix */ +html[data-theme="dark"] .highlight .sb { color: #e6db74 } /* Literal.String.Backtick */ +html[data-theme="dark"] .highlight .sc { color: #e6db74 } /* Literal.String.Char */ +html[data-theme="dark"] .highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */ +html[data-theme="dark"] .highlight .sd { color: #e6db74 } /* Literal.String.Doc */ +html[data-theme="dark"] .highlight .s2 { color: #e6db74 } /* Literal.String.Double */ +html[data-theme="dark"] .highlight .se { color: #ae81ff } /* Literal.String.Escape */ +html[data-theme="dark"] .highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */ +html[data-theme="dark"] .highlight .si { color: #e6db74 } /* Literal.String.Interpol */ +html[data-theme="dark"] .highlight .sx { color: #e6db74 } /* Literal.String.Other */ +html[data-theme="dark"] .highlight .sr { color: #e6db74 } /* Literal.String.Regex */ +html[data-theme="dark"] .highlight .s1 { color: #e6db74 } /* Literal.String.Single */ +html[data-theme="dark"] .highlight .ss { color: #e6db74 } /* Literal.String.Symbol */ +html[data-theme="dark"] .highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */ +html[data-theme="dark"] .highlight .fm { color: #a6e22e } /* Name.Function.Magic */ +html[data-theme="dark"] .highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */ +html[data-theme="dark"] .highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */ +html[data-theme="dark"] .highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */ +html[data-theme="dark"] .highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */ +html[data-theme="dark"] .highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/scripts/bootstrap.js b/_static/scripts/bootstrap.js new file mode 100644 index 00000000..c8178deb --- /dev/null +++ b/_static/scripts/bootstrap.js @@ -0,0 +1,3 @@ +/*! For license information please see bootstrap.js.LICENSE.txt */ +(()=>{"use strict";var t={d:(e,i)=>{for(var n in i)t.o(i,n)&&!t.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:i[n]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e),r:t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})}},e={};t.r(e),t.d(e,{afterMain:()=>E,afterRead:()=>v,afterWrite:()=>C,applyStyles:()=>$,arrow:()=>J,auto:()=>a,basePlacements:()=>l,beforeMain:()=>y,beforeRead:()=>_,beforeWrite:()=>A,bottom:()=>s,clippingParents:()=>d,computeStyles:()=>it,createPopper:()=>Dt,createPopperBase:()=>St,createPopperLite:()=>$t,detectOverflow:()=>_t,end:()=>h,eventListeners:()=>st,flip:()=>bt,hide:()=>wt,left:()=>r,main:()=>w,modifierPhases:()=>O,offset:()=>Et,placements:()=>g,popper:()=>f,popperGenerator:()=>Lt,popperOffsets:()=>At,preventOverflow:()=>Tt,read:()=>b,reference:()=>p,right:()=>o,start:()=>c,top:()=>n,variationPlacements:()=>m,viewport:()=>u,write:()=>T});var i={};t.r(i),t.d(i,{Alert:()=>Oe,Button:()=>ke,Carousel:()=>li,Collapse:()=>Ei,Dropdown:()=>Ki,Modal:()=>Ln,Offcanvas:()=>Kn,Popover:()=>bs,ScrollSpy:()=>Ls,Tab:()=>Js,Toast:()=>po,Tooltip:()=>fs});var n="top",s="bottom",o="right",r="left",a="auto",l=[n,s,o,r],c="start",h="end",d="clippingParents",u="viewport",f="popper",p="reference",m=l.reduce((function(t,e){return t.concat([e+"-"+c,e+"-"+h])}),[]),g=[].concat(l,[a]).reduce((function(t,e){return t.concat([e,e+"-"+c,e+"-"+h])}),[]),_="beforeRead",b="read",v="afterRead",y="beforeMain",w="main",E="afterMain",A="beforeWrite",T="write",C="afterWrite",O=[_,b,v,y,w,E,A,T,C];function x(t){return t?(t.nodeName||"").toLowerCase():null}function k(t){if(null==t)return window;if("[object Window]"!==t.toString()){var e=t.ownerDocument;return e&&e.defaultView||window}return t}function L(t){return t instanceof k(t).Element||t instanceof Element}function S(t){return t instanceof k(t).HTMLElement||t instanceof HTMLElement}function D(t){return"undefined"!=typeof ShadowRoot&&(t instanceof k(t).ShadowRoot||t instanceof ShadowRoot)}const $={name:"applyStyles",enabled:!0,phase:"write",fn:function(t){var e=t.state;Object.keys(e.elements).forEach((function(t){var i=e.styles[t]||{},n=e.attributes[t]||{},s=e.elements[t];S(s)&&x(s)&&(Object.assign(s.style,i),Object.keys(n).forEach((function(t){var e=n[t];!1===e?s.removeAttribute(t):s.setAttribute(t,!0===e?"":e)})))}))},effect:function(t){var e=t.state,i={popper:{position:e.options.strategy,left:"0",top:"0",margin:"0"},arrow:{position:"absolute"},reference:{}};return Object.assign(e.elements.popper.style,i.popper),e.styles=i,e.elements.arrow&&Object.assign(e.elements.arrow.style,i.arrow),function(){Object.keys(e.elements).forEach((function(t){var n=e.elements[t],s=e.attributes[t]||{},o=Object.keys(e.styles.hasOwnProperty(t)?e.styles[t]:i[t]).reduce((function(t,e){return t[e]="",t}),{});S(n)&&x(n)&&(Object.assign(n.style,o),Object.keys(s).forEach((function(t){n.removeAttribute(t)})))}))}},requires:["computeStyles"]};function I(t){return t.split("-")[0]}var N=Math.max,P=Math.min,M=Math.round;function j(){var t=navigator.userAgentData;return null!=t&&t.brands&&Array.isArray(t.brands)?t.brands.map((function(t){return t.brand+"/"+t.version})).join(" "):navigator.userAgent}function F(){return!/^((?!chrome|android).)*safari/i.test(j())}function H(t,e,i){void 0===e&&(e=!1),void 0===i&&(i=!1);var n=t.getBoundingClientRect(),s=1,o=1;e&&S(t)&&(s=t.offsetWidth>0&&M(n.width)/t.offsetWidth||1,o=t.offsetHeight>0&&M(n.height)/t.offsetHeight||1);var r=(L(t)?k(t):window).visualViewport,a=!F()&&i,l=(n.left+(a&&r?r.offsetLeft:0))/s,c=(n.top+(a&&r?r.offsetTop:0))/o,h=n.width/s,d=n.height/o;return{width:h,height:d,top:c,right:l+h,bottom:c+d,left:l,x:l,y:c}}function B(t){var e=H(t),i=t.offsetWidth,n=t.offsetHeight;return Math.abs(e.width-i)<=1&&(i=e.width),Math.abs(e.height-n)<=1&&(n=e.height),{x:t.offsetLeft,y:t.offsetTop,width:i,height:n}}function W(t,e){var i=e.getRootNode&&e.getRootNode();if(t.contains(e))return!0;if(i&&D(i)){var n=e;do{if(n&&t.isSameNode(n))return!0;n=n.parentNode||n.host}while(n)}return!1}function z(t){return k(t).getComputedStyle(t)}function R(t){return["table","td","th"].indexOf(x(t))>=0}function q(t){return((L(t)?t.ownerDocument:t.document)||window.document).documentElement}function V(t){return"html"===x(t)?t:t.assignedSlot||t.parentNode||(D(t)?t.host:null)||q(t)}function Y(t){return S(t)&&"fixed"!==z(t).position?t.offsetParent:null}function K(t){for(var e=k(t),i=Y(t);i&&R(i)&&"static"===z(i).position;)i=Y(i);return i&&("html"===x(i)||"body"===x(i)&&"static"===z(i).position)?e:i||function(t){var e=/firefox/i.test(j());if(/Trident/i.test(j())&&S(t)&&"fixed"===z(t).position)return null;var i=V(t);for(D(i)&&(i=i.host);S(i)&&["html","body"].indexOf(x(i))<0;){var n=z(i);if("none"!==n.transform||"none"!==n.perspective||"paint"===n.contain||-1!==["transform","perspective"].indexOf(n.willChange)||e&&"filter"===n.willChange||e&&n.filter&&"none"!==n.filter)return i;i=i.parentNode}return null}(t)||e}function Q(t){return["top","bottom"].indexOf(t)>=0?"x":"y"}function X(t,e,i){return N(t,P(e,i))}function U(t){return Object.assign({},{top:0,right:0,bottom:0,left:0},t)}function G(t,e){return e.reduce((function(e,i){return e[i]=t,e}),{})}const J={name:"arrow",enabled:!0,phase:"main",fn:function(t){var e,i=t.state,a=t.name,c=t.options,h=i.elements.arrow,d=i.modifiersData.popperOffsets,u=I(i.placement),f=Q(u),p=[r,o].indexOf(u)>=0?"height":"width";if(h&&d){var m=function(t,e){return U("number"!=typeof(t="function"==typeof t?t(Object.assign({},e.rects,{placement:e.placement})):t)?t:G(t,l))}(c.padding,i),g=B(h),_="y"===f?n:r,b="y"===f?s:o,v=i.rects.reference[p]+i.rects.reference[f]-d[f]-i.rects.popper[p],y=d[f]-i.rects.reference[f],w=K(h),E=w?"y"===f?w.clientHeight||0:w.clientWidth||0:0,A=v/2-y/2,T=m[_],C=E-g[p]-m[b],O=E/2-g[p]/2+A,x=X(T,O,C),k=f;i.modifiersData[a]=((e={})[k]=x,e.centerOffset=x-O,e)}},effect:function(t){var e=t.state,i=t.options.element,n=void 0===i?"[data-popper-arrow]":i;null!=n&&("string"!=typeof n||(n=e.elements.popper.querySelector(n)))&&W(e.elements.popper,n)&&(e.elements.arrow=n)},requires:["popperOffsets"],requiresIfExists:["preventOverflow"]};function Z(t){return t.split("-")[1]}var tt={top:"auto",right:"auto",bottom:"auto",left:"auto"};function et(t){var e,i=t.popper,a=t.popperRect,l=t.placement,c=t.variation,d=t.offsets,u=t.position,f=t.gpuAcceleration,p=t.adaptive,m=t.roundOffsets,g=t.isFixed,_=d.x,b=void 0===_?0:_,v=d.y,y=void 0===v?0:v,w="function"==typeof m?m({x:b,y}):{x:b,y};b=w.x,y=w.y;var E=d.hasOwnProperty("x"),A=d.hasOwnProperty("y"),T=r,C=n,O=window;if(p){var x=K(i),L="clientHeight",S="clientWidth";x===k(i)&&"static"!==z(x=q(i)).position&&"absolute"===u&&(L="scrollHeight",S="scrollWidth"),(l===n||(l===r||l===o)&&c===h)&&(C=s,y-=(g&&x===O&&O.visualViewport?O.visualViewport.height:x[L])-a.height,y*=f?1:-1),l!==r&&(l!==n&&l!==s||c!==h)||(T=o,b-=(g&&x===O&&O.visualViewport?O.visualViewport.width:x[S])-a.width,b*=f?1:-1)}var D,$=Object.assign({position:u},p&&tt),I=!0===m?function(t,e){var i=t.x,n=t.y,s=e.devicePixelRatio||1;return{x:M(i*s)/s||0,y:M(n*s)/s||0}}({x:b,y},k(i)):{x:b,y};return b=I.x,y=I.y,f?Object.assign({},$,((D={})[C]=A?"0":"",D[T]=E?"0":"",D.transform=(O.devicePixelRatio||1)<=1?"translate("+b+"px, "+y+"px)":"translate3d("+b+"px, "+y+"px, 0)",D)):Object.assign({},$,((e={})[C]=A?y+"px":"",e[T]=E?b+"px":"",e.transform="",e))}const it={name:"computeStyles",enabled:!0,phase:"beforeWrite",fn:function(t){var e=t.state,i=t.options,n=i.gpuAcceleration,s=void 0===n||n,o=i.adaptive,r=void 0===o||o,a=i.roundOffsets,l=void 0===a||a,c={placement:I(e.placement),variation:Z(e.placement),popper:e.elements.popper,popperRect:e.rects.popper,gpuAcceleration:s,isFixed:"fixed"===e.options.strategy};null!=e.modifiersData.popperOffsets&&(e.styles.popper=Object.assign({},e.styles.popper,et(Object.assign({},c,{offsets:e.modifiersData.popperOffsets,position:e.options.strategy,adaptive:r,roundOffsets:l})))),null!=e.modifiersData.arrow&&(e.styles.arrow=Object.assign({},e.styles.arrow,et(Object.assign({},c,{offsets:e.modifiersData.arrow,position:"absolute",adaptive:!1,roundOffsets:l})))),e.attributes.popper=Object.assign({},e.attributes.popper,{"data-popper-placement":e.placement})},data:{}};var nt={passive:!0};const st={name:"eventListeners",enabled:!0,phase:"write",fn:function(){},effect:function(t){var e=t.state,i=t.instance,n=t.options,s=n.scroll,o=void 0===s||s,r=n.resize,a=void 0===r||r,l=k(e.elements.popper),c=[].concat(e.scrollParents.reference,e.scrollParents.popper);return o&&c.forEach((function(t){t.addEventListener("scroll",i.update,nt)})),a&&l.addEventListener("resize",i.update,nt),function(){o&&c.forEach((function(t){t.removeEventListener("scroll",i.update,nt)})),a&&l.removeEventListener("resize",i.update,nt)}},data:{}};var ot={left:"right",right:"left",bottom:"top",top:"bottom"};function rt(t){return t.replace(/left|right|bottom|top/g,(function(t){return ot[t]}))}var at={start:"end",end:"start"};function lt(t){return t.replace(/start|end/g,(function(t){return at[t]}))}function ct(t){var e=k(t);return{scrollLeft:e.pageXOffset,scrollTop:e.pageYOffset}}function ht(t){return H(q(t)).left+ct(t).scrollLeft}function dt(t){var e=z(t),i=e.overflow,n=e.overflowX,s=e.overflowY;return/auto|scroll|overlay|hidden/.test(i+s+n)}function ut(t){return["html","body","#document"].indexOf(x(t))>=0?t.ownerDocument.body:S(t)&&dt(t)?t:ut(V(t))}function ft(t,e){var i;void 0===e&&(e=[]);var n=ut(t),s=n===(null==(i=t.ownerDocument)?void 0:i.body),o=k(n),r=s?[o].concat(o.visualViewport||[],dt(n)?n:[]):n,a=e.concat(r);return s?a:a.concat(ft(V(r)))}function pt(t){return Object.assign({},t,{left:t.x,top:t.y,right:t.x+t.width,bottom:t.y+t.height})}function mt(t,e,i){return e===u?pt(function(t,e){var i=k(t),n=q(t),s=i.visualViewport,o=n.clientWidth,r=n.clientHeight,a=0,l=0;if(s){o=s.width,r=s.height;var c=F();(c||!c&&"fixed"===e)&&(a=s.offsetLeft,l=s.offsetTop)}return{width:o,height:r,x:a+ht(t),y:l}}(t,i)):L(e)?function(t,e){var i=H(t,!1,"fixed"===e);return i.top=i.top+t.clientTop,i.left=i.left+t.clientLeft,i.bottom=i.top+t.clientHeight,i.right=i.left+t.clientWidth,i.width=t.clientWidth,i.height=t.clientHeight,i.x=i.left,i.y=i.top,i}(e,i):pt(function(t){var e,i=q(t),n=ct(t),s=null==(e=t.ownerDocument)?void 0:e.body,o=N(i.scrollWidth,i.clientWidth,s?s.scrollWidth:0,s?s.clientWidth:0),r=N(i.scrollHeight,i.clientHeight,s?s.scrollHeight:0,s?s.clientHeight:0),a=-n.scrollLeft+ht(t),l=-n.scrollTop;return"rtl"===z(s||i).direction&&(a+=N(i.clientWidth,s?s.clientWidth:0)-o),{width:o,height:r,x:a,y:l}}(q(t)))}function gt(t){var e,i=t.reference,a=t.element,l=t.placement,d=l?I(l):null,u=l?Z(l):null,f=i.x+i.width/2-a.width/2,p=i.y+i.height/2-a.height/2;switch(d){case n:e={x:f,y:i.y-a.height};break;case s:e={x:f,y:i.y+i.height};break;case o:e={x:i.x+i.width,y:p};break;case r:e={x:i.x-a.width,y:p};break;default:e={x:i.x,y:i.y}}var m=d?Q(d):null;if(null!=m){var g="y"===m?"height":"width";switch(u){case c:e[m]=e[m]-(i[g]/2-a[g]/2);break;case h:e[m]=e[m]+(i[g]/2-a[g]/2)}}return e}function _t(t,e){void 0===e&&(e={});var i=e,r=i.placement,a=void 0===r?t.placement:r,c=i.strategy,h=void 0===c?t.strategy:c,m=i.boundary,g=void 0===m?d:m,_=i.rootBoundary,b=void 0===_?u:_,v=i.elementContext,y=void 0===v?f:v,w=i.altBoundary,E=void 0!==w&&w,A=i.padding,T=void 0===A?0:A,C=U("number"!=typeof T?T:G(T,l)),O=y===f?p:f,k=t.rects.popper,D=t.elements[E?O:y],$=function(t,e,i,n){var s="clippingParents"===e?function(t){var e=ft(V(t)),i=["absolute","fixed"].indexOf(z(t).position)>=0&&S(t)?K(t):t;return L(i)?e.filter((function(t){return L(t)&&W(t,i)&&"body"!==x(t)})):[]}(t):[].concat(e),o=[].concat(s,[i]),r=o[0],a=o.reduce((function(e,i){var s=mt(t,i,n);return e.top=N(s.top,e.top),e.right=P(s.right,e.right),e.bottom=P(s.bottom,e.bottom),e.left=N(s.left,e.left),e}),mt(t,r,n));return a.width=a.right-a.left,a.height=a.bottom-a.top,a.x=a.left,a.y=a.top,a}(L(D)?D:D.contextElement||q(t.elements.popper),g,b,h),I=H(t.elements.reference),M=gt({reference:I,element:k,strategy:"absolute",placement:a}),j=pt(Object.assign({},k,M)),F=y===f?j:I,B={top:$.top-F.top+C.top,bottom:F.bottom-$.bottom+C.bottom,left:$.left-F.left+C.left,right:F.right-$.right+C.right},R=t.modifiersData.offset;if(y===f&&R){var Y=R[a];Object.keys(B).forEach((function(t){var e=[o,s].indexOf(t)>=0?1:-1,i=[n,s].indexOf(t)>=0?"y":"x";B[t]+=Y[i]*e}))}return B}const bt={name:"flip",enabled:!0,phase:"main",fn:function(t){var e=t.state,i=t.options,h=t.name;if(!e.modifiersData[h]._skip){for(var d=i.mainAxis,u=void 0===d||d,f=i.altAxis,p=void 0===f||f,_=i.fallbackPlacements,b=i.padding,v=i.boundary,y=i.rootBoundary,w=i.altBoundary,E=i.flipVariations,A=void 0===E||E,T=i.allowedAutoPlacements,C=e.options.placement,O=I(C),x=_||(O!==C&&A?function(t){if(I(t)===a)return[];var e=rt(t);return[lt(t),e,lt(e)]}(C):[rt(C)]),k=[C].concat(x).reduce((function(t,i){return t.concat(I(i)===a?function(t,e){void 0===e&&(e={});var i=e,n=i.placement,s=i.boundary,o=i.rootBoundary,r=i.padding,a=i.flipVariations,c=i.allowedAutoPlacements,h=void 0===c?g:c,d=Z(n),u=d?a?m:m.filter((function(t){return Z(t)===d})):l,f=u.filter((function(t){return h.indexOf(t)>=0}));0===f.length&&(f=u);var p=f.reduce((function(e,i){return e[i]=_t(t,{placement:i,boundary:s,rootBoundary:o,padding:r})[I(i)],e}),{});return Object.keys(p).sort((function(t,e){return p[t]-p[e]}))}(e,{placement:i,boundary:v,rootBoundary:y,padding:b,flipVariations:A,allowedAutoPlacements:T}):i)}),[]),L=e.rects.reference,S=e.rects.popper,D=new Map,$=!0,N=k[0],P=0;P